1 /*
   2  * Copyright (c) 2012, 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 
  26 #include "precompiled.hpp"
  27 #include "gc_implementation/g1/g1CollectedHeap.inline.hpp"
  28 #include "gc_implementation/g1/g1GCPhaseTimes.hpp"
  29 #include "gc_implementation/g1/g1Log.hpp"
  30 
  31 // Helper class for avoiding interleaved logging
  32 class LineBuffer: public StackObj {
  33 
  34 private:
  35   static const int BUFFER_LEN = 1024;
  36   static const int INDENT_CHARS = 3;
  37   char _buffer[BUFFER_LEN];
  38   int _indent_level;
  39   int _cur;
  40 
  41   void vappend(const char* format, va_list ap) {
  42     int res = vsnprintf(&_buffer[_cur], BUFFER_LEN - _cur, format, ap);
  43     if (res != -1) {
  44       _cur += res;
  45     } else {
  46       DEBUG_ONLY(warning("buffer too small in LineBuffer");)
  47       _buffer[BUFFER_LEN -1] = 0;
  48       _cur = BUFFER_LEN; // vsnprintf above should not add to _buffer if we are called again
  49     }
  50   }
  51 
  52 public:
  53   explicit LineBuffer(int indent_level): _indent_level(indent_level), _cur(0) {
  54     for (; (_cur < BUFFER_LEN && _cur < (_indent_level * INDENT_CHARS)); _cur++) {
  55       _buffer[_cur] = ' ';
  56     }
  57   }
  58 
  59 #ifndef PRODUCT
  60   ~LineBuffer() {
  61     assert(_cur == _indent_level * INDENT_CHARS, "pending data in buffer - append_and_print_cr() not called?");
  62   }
  63 #endif
  64 
  65   void append(const char* format, ...) {
  66     va_list ap;
  67     va_start(ap, format);
  68     vappend(format, ap);
  69     va_end(ap);
  70   }
  71 
  72   void append_and_print_cr(const char* format, ...) {
  73     va_list ap;
  74     va_start(ap, format);
  75     vappend(format, ap);
  76     va_end(ap);
  77     gclog_or_tty->print_cr("%s", _buffer);
  78     _cur = _indent_level * INDENT_CHARS;
  79   }
  80 };
  81 
  82 template <class T>
  83 void WorkerDataArray<T>::print(int level, const char* title) {
  84   if (_length == 1) {
  85     // No need for min, max, average and sum for only one worker
  86     LineBuffer buf(level);
  87     buf.append("[%s:  ", title);
  88     buf.append(_print_format, _data[0]);
  89     buf.append_and_print_cr("]");
  90     return;
  91   }
  92 
  93   T min = _data[0];
  94   T max = _data[0];
  95   T sum = 0;
  96 
  97   LineBuffer buf(level);
  98   buf.append("[%s:", title);
  99   for (uint i = 0; i < _length; ++i) {
 100     T val = _data[i];
 101     min = MIN2(val, min);
 102     max = MAX2(val, max);
 103     sum += val;
 104     if (G1Log::finest()) {
 105       buf.append("  ");
 106       buf.append(_print_format, val);
 107     }
 108   }
 109 
 110   if (G1Log::finest()) {
 111     buf.append_and_print_cr("");
 112   }
 113 
 114   double avg = (double)sum / (double)_length;
 115   buf.append(" Min: ");
 116   buf.append(_print_format, min);
 117   buf.append(", Avg: ");
 118   buf.append("%.1lf", avg); // Always print average as a double
 119   buf.append(", Max: ");
 120   buf.append(_print_format, max);
 121   buf.append(", Diff: ");
 122   buf.append(_print_format, max - min);
 123   if (_print_sum) {
 124     // for things like the start and end times the sum is not
 125     // that relevant
 126     buf.append(", Sum: ");
 127     buf.append(_print_format, sum);
 128   }
 129   buf.append_and_print_cr("]");
 130 }
 131 
 132 #ifdef ASSERT
 133 
 134 template <class T>
 135 void WorkerDataArray<T>::reset() {
 136   for (uint i = 0; i < _length; i++) {
 137     _data[i] = (T)-1;
 138   }
 139 }
 140 
 141 template <class T>
 142 void WorkerDataArray<T>::verify() {
 143   for (uint i = 0; i < _length; i++) {
 144     assert(_data[i] >= (T)0, err_msg("Invalid data for worker %d", i));
 145   }
 146 }
 147 
 148 #endif
 149 
 150 G1GCPhaseTimes::G1GCPhaseTimes(uint max_gc_threads) :
 151   _max_gc_threads(max_gc_threads),
 152   _min_clear_cc_time_ms(-1.0),
 153   _max_clear_cc_time_ms(-1.0),
 154   _cur_clear_cc_time_ms(0.0),
 155   _cum_clear_cc_time_ms(0.0),
 156   _num_cc_clears(0L),
 157   _last_gc_worker_start_times_ms(_max_gc_threads, "%.1lf", false),
 158   _last_ext_root_scan_times_ms(_max_gc_threads, "%.1lf"),
 159   _last_satb_filtering_times_ms(_max_gc_threads, "%.1lf"),
 160   _last_update_rs_times_ms(_max_gc_threads, "%.1lf"),
 161   _last_update_rs_processed_buffers(_max_gc_threads, "%d"),
 162   _last_scan_rs_times_ms(_max_gc_threads, "%.1lf"),
 163   _last_obj_copy_times_ms(_max_gc_threads, "%.1lf"),
 164   _last_termination_times_ms(_max_gc_threads, "%.1lf"),
 165   _last_termination_attempts(_max_gc_threads, SIZE_FORMAT),
 166   _last_gc_worker_end_times_ms(_max_gc_threads, "%.1lf", false),
 167   _last_gc_worker_times_ms(_max_gc_threads, "%.1lf"),
 168   _last_gc_worker_other_times_ms(_max_gc_threads, "%.1lf")
 169 {
 170   assert(max_gc_threads > 0, "Must have some GC threads");
 171 }
 172 
 173 void G1GCPhaseTimes::note_gc_start(double pause_start_time_sec, uint active_gc_threads,
 174   bool is_young_gc, bool is_initial_mark_gc, GCCause::Cause gc_cause) {
 175   assert(active_gc_threads > 0, "The number of threads must be > 0");
 176   assert(active_gc_threads <= _max_gc_threads, "The number of active threads must be <= the max nubmer of threads");
 177   _active_gc_threads = active_gc_threads;
 178   _pause_start_time_sec = pause_start_time_sec;
 179   _is_young_gc = is_young_gc;
 180   _is_initial_mark_gc = is_initial_mark_gc;
 181   _gc_cause = gc_cause;
 182 
 183   _last_gc_worker_start_times_ms.reset();
 184   _last_ext_root_scan_times_ms.reset();
 185   _last_satb_filtering_times_ms.reset();
 186   _last_update_rs_times_ms.reset();
 187   _last_update_rs_processed_buffers.reset();
 188   _last_scan_rs_times_ms.reset();
 189   _last_obj_copy_times_ms.reset();
 190   _last_termination_times_ms.reset();
 191   _last_termination_attempts.reset();
 192   _last_gc_worker_end_times_ms.reset();
 193   _last_gc_worker_times_ms.reset();
 194   _last_gc_worker_other_times_ms.reset();
 195 }
 196 
 197 void G1GCPhaseTimes::note_gc_end(double pause_end_time_sec) {
 198   _last_gc_worker_start_times_ms.verify();
 199   _last_ext_root_scan_times_ms.verify();
 200   _last_satb_filtering_times_ms.verify();
 201   _last_update_rs_times_ms.verify();
 202   _last_update_rs_processed_buffers.verify();
 203   _last_scan_rs_times_ms.verify();
 204   _last_obj_copy_times_ms.verify();
 205   _last_termination_times_ms.verify();
 206   _last_termination_attempts.verify();
 207   _last_gc_worker_end_times_ms.verify();
 208 
 209   if (G1Log::fine()) {
 210     double pause_time_ms = (pause_end_time_sec - _pause_start_time_sec) * MILLIUNITS;
 211 
 212     for (uint i = 0; i < _active_gc_threads; i++) {
 213       _last_gc_worker_times_ms.set(i,
 214         _last_gc_worker_end_times_ms.get(i) - _last_gc_worker_start_times_ms.get(i));
 215 
 216       double worker_known_time = _last_ext_root_scan_times_ms.get(i) +
 217         _last_satb_filtering_times_ms.get(i) +
 218         _last_update_rs_times_ms.get(i) +
 219         _last_scan_rs_times_ms.get(i) +
 220         _last_obj_copy_times_ms.get(i) +
 221         _last_termination_times_ms.get(i);
 222 
 223       _last_gc_worker_other_times_ms.set(i,
 224         _last_gc_worker_times_ms.get(i) - worker_known_time);
 225     }
 226 
 227     _last_gc_worker_times_ms.verify();
 228     _last_gc_worker_other_times_ms.verify();
 229 
 230     print(pause_time_ms);
 231   }
 232 
 233 }
 234 
 235 void G1GCPhaseTimes::print_stats(int level, const char* str, double value) {
 236   LineBuffer(level).append_and_print_cr("[%s: %.1lf ms]", str, value);
 237 }
 238 
 239 void G1GCPhaseTimes::print_stats(int level, const char* str, double value, int workers) {
 240   LineBuffer(level).append_and_print_cr("[%s: %.1lf ms, GC Workers: %d]", str, value, workers);
 241 }
 242 
 243 double G1GCPhaseTimes::accounted_time_ms() {
 244     // Subtract the root region scanning wait time. It's initialized to
 245     // zero at the start of the pause.
 246     double misc_time_ms = _root_region_scan_wait_time_ms;
 247 
 248     misc_time_ms += _cur_collection_par_time_ms;
 249 
 250     // Now subtract the time taken to fix up roots in generated code
 251     misc_time_ms += _cur_collection_code_root_fixup_time_ms;
 252 
 253     // Subtract the time taken to clean the card table from the
 254     // current value of "other time"
 255     misc_time_ms += _cur_clear_ct_time_ms;
 256 
 257     return misc_time_ms;
 258 }
 259 
 260 void G1GCPhaseTimes::print(double pause_time_ms) {
 261 
 262   if (PrintGCTimeStamps) {
 263     gclog_or_tty->stamp();
 264     gclog_or_tty->print(": ");
 265   }
 266 
 267   GCCauseString gc_cause_str = GCCauseString("GC pause", _gc_cause)
 268     .append(_is_young_gc ? " (young)" : " (mixed)")
 269     .append(_is_initial_mark_gc ? " (initial-mark)" : "");
 270   gclog_or_tty->print_cr("[%s, %3.7f secs]", (const char*)gc_cause_str, pause_time_ms / 1000.0);
 271 
 272   if (!G1Log::finer()) {
 273     return;
 274   }
 275 
 276   if (_root_region_scan_wait_time_ms > 0.0) {
 277     print_stats(1, "Root Region Scan Waiting", _root_region_scan_wait_time_ms);
 278   }
 279   if (G1CollectedHeap::use_parallel_gc_threads()) {
 280     print_stats(1, "Parallel Time", _cur_collection_par_time_ms, _active_gc_threads);
 281     _last_gc_worker_start_times_ms.print(2, "GC Worker Start (ms)");
 282     _last_ext_root_scan_times_ms.print(2, "Ext Root Scanning (ms)");
 283     if (_last_satb_filtering_times_ms.sum() > 0.0) {
 284       _last_satb_filtering_times_ms.print(2, "SATB Filtering (ms)");
 285     }
 286     _last_update_rs_times_ms.print(2, "Update RS (ms)");
 287     if (G1Log::finest()) {
 288       _last_update_rs_processed_buffers.print(3, "Processed Buffers");
 289     }
 290     _last_scan_rs_times_ms.print(2, "Scan RS (ms)");
 291     _last_obj_copy_times_ms.print(2, "Object Copy (ms)");
 292     _last_termination_times_ms.print(2, "Termination (ms)");
 293     if (G1Log::finest()) {
 294       _last_termination_attempts.print(3, "Termination Attempts");
 295     }
 296     _last_gc_worker_other_times_ms.print(2, "GC Worker Other (ms)");
 297     _last_gc_worker_times_ms.print(2, "GC Worker Total (ms)");
 298     _last_gc_worker_end_times_ms.print(2, "GC Worker End (ms)");
 299   } else {
 300     _last_ext_root_scan_times_ms.print(1, "Ext Root Scanning (ms)");
 301     if (_last_satb_filtering_times_ms.sum() > 0.0) {
 302       _last_satb_filtering_times_ms.print(1, "SATB Filtering (ms)");
 303     }
 304     _last_update_rs_times_ms.print(1, "Update RS (ms)");
 305     if (G1Log::finest()) {
 306       _last_update_rs_processed_buffers.print(2, "Processed Buffers");
 307     }
 308     _last_scan_rs_times_ms.print(1, "Scan RS (ms)");
 309     _last_obj_copy_times_ms.print(1, "Object Copy (ms)");
 310   }
 311   print_stats(1, "Code Root Fixup", _cur_collection_code_root_fixup_time_ms);
 312   print_stats(1, "Clear CT", _cur_clear_ct_time_ms);
 313   if (Verbose && G1Log::finest()) {
 314     print_stats(1, "Cur Clear CC", _cur_clear_cc_time_ms);
 315     print_stats(1, "Cum Clear CC", _cum_clear_cc_time_ms);
 316     print_stats(1, "Min Clear CC", _min_clear_cc_time_ms);
 317     print_stats(1, "Max Clear CC", _max_clear_cc_time_ms);
 318     if (_num_cc_clears > 0) {
 319       print_stats(1, "Avg Clear CC", _cum_clear_cc_time_ms / ((double)_num_cc_clears));
 320     }
 321   }
 322   double misc_time_ms = pause_time_ms - accounted_time_ms();
 323   print_stats(1, "Other", misc_time_ms);
 324   print_stats(2, "Choose CSet",
 325     (_recorded_young_cset_choice_time_ms +
 326     _recorded_non_young_cset_choice_time_ms));
 327   print_stats(2, "Ref Proc", _cur_ref_proc_time_ms);
 328   print_stats(2, "Ref Enq", _cur_ref_enq_time_ms);
 329   print_stats(2, "Free CSet",
 330     (_recorded_young_free_cset_time_ms +
 331     _recorded_non_young_free_cset_time_ms));
 332 }
 333 
 334 void G1GCPhaseTimes::record_cc_clear_time_ms(double ms) {
 335   if (!(Verbose && G1Log::finest())) {
 336     return;
 337   }
 338 
 339   if (_min_clear_cc_time_ms < 0.0 || ms <= _min_clear_cc_time_ms) {
 340     _min_clear_cc_time_ms = ms;
 341   }
 342   if (_max_clear_cc_time_ms < 0.0 || ms >= _max_clear_cc_time_ms) {
 343     _max_clear_cc_time_ms = ms;
 344   }
 345   _cur_clear_cc_time_ms = ms;
 346   _cum_clear_cc_time_ms += ms;
 347   _num_cc_clears++;
 348 }