1 /*
   2  * Copyright (c) 2002, 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_INTERFACE_GCCAUSE_HPP
  26 #define SHARE_VM_GC_INTERFACE_GCCAUSE_HPP
  27 
  28 #include "memory/allocation.hpp"
  29 
  30 //
  31 // This class exposes implementation details of the various
  32 // collector(s), and we need to be very careful with it. If
  33 // use of this class grows, we should split it into public
  34 // and implemenation-private "causes".
  35 //
  36 
  37 class GCCause : public AllStatic {
  38  public:
  39   enum Cause {
  40     /* public */
  41     _java_lang_system_gc,
  42     _full_gc_alot,
  43     _scavenge_alot,
  44     _allocation_profiler,
  45     _jvmti_force_gc,
  46     _gc_locker,
  47     _heap_inspection,
  48     _heap_dump,
  49     _wb_young_gc,
  50     _wb_conc_mark,
  51     _update_allocation_context_stats_inc,
  52     _update_allocation_context_stats_full,
  53 
  54     /* implementation independent, but reserved for GC use */
  55     _no_gc,
  56     _no_cause_specified,
  57     _allocation_failure,
  58 
  59     /* implementation specific */
  60 
  61     _tenured_generation_full,
  62     _metadata_GC_threshold,
  63 
  64     _cms_generation_full,
  65     _cms_initial_mark,
  66     _cms_final_remark,
  67     _cms_concurrent_mark,
  68 
  69     _old_generation_expanded_on_last_scavenge,
  70     _old_generation_too_full_to_scavenge,
  71     _adaptive_size_policy,
  72 
  73     _g1_inc_collection_pause,
  74     _g1_humongous_allocation,
  75 
  76     _shenandoah_stop_vm,
  77     _shenandoah_metadata_gc_clear_softrefs,
  78     _shenandoah_allocation_failure_evac,
  79     _shenandoah_concurrent_gc,
  80     _shenandoah_upgrade_to_full_gc,
  81 
  82     _last_ditch_collection,
  83     _last_gc_cause
  84   };
  85 
  86   inline static bool is_user_requested_gc(GCCause::Cause cause) {
  87     return (cause == GCCause::_java_lang_system_gc ||
  88             cause == GCCause::_jvmti_force_gc);
  89   }
  90 
  91   inline static bool is_serviceability_requested_gc(GCCause::Cause
  92                                                              cause) {
  93     return (cause == GCCause::_jvmti_force_gc ||
  94             cause == GCCause::_heap_inspection ||
  95             cause == GCCause::_heap_dump);
  96   }
  97 
  98   // Return a string describing the GCCause.
  99   static const char* to_string(GCCause::Cause cause);
 100 };
 101 
 102 // Helper class for doing logging that includes the GC Cause
 103 // as a string.
 104 class GCCauseString : StackObj {
 105  private:
 106    static const int _length = 128;
 107    char _buffer[_length];
 108    int _position;
 109 
 110  public:
 111    GCCauseString(const char* prefix, GCCause::Cause cause) {
 112      if (PrintGCCause) {
 113       _position = jio_snprintf(_buffer, _length, "%s (%s) ", prefix, GCCause::to_string(cause));
 114      } else {
 115       _position = jio_snprintf(_buffer, _length, "%s ", prefix);
 116      }
 117      assert(_position >= 0 && _position <= _length,
 118        err_msg("Need to increase the buffer size in GCCauseString? %d", _position));
 119    }
 120 
 121    GCCauseString& append(const char* str) {
 122      int res = jio_snprintf(_buffer + _position, _length - _position, "%s", str);
 123      _position += res;
 124      assert(res >= 0 && _position <= _length,
 125        err_msg("Need to increase the buffer size in GCCauseString? %d", res));
 126      return *this;
 127    }
 128 
 129    operator const char*() {
 130      return _buffer;
 131    }
 132 };
 133 
 134 #endif // SHARE_VM_GC_INTERFACE_GCCAUSE_HPP