1 /*
   2  * Copyright (c) 2002, 2009, 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 // This class exposes implementation details of the various
  27 // collector(s), and we need to be very careful with it. If
  28 // use of this class grows, we should split it into public
  29 // and implemenation-private "causes".
  30 //
  31 
  32 class GCCause : public AllStatic {
  33  public:
  34   enum Cause {
  35     /* public */
  36     _java_lang_system_gc,
  37     _full_gc_alot,
  38     _scavenge_alot,
  39     _allocation_profiler,
  40     _jvmti_force_gc,
  41     _gc_locker,
  42     _heap_inspection,
  43     _heap_dump,
  44 
  45     /* implementation independent, but reserved for GC use */
  46     _no_gc,
  47     _no_cause_specified,
  48     _allocation_failure,
  49 
  50     /* implementation specific */
  51 
  52     _tenured_generation_full,
  53     _permanent_generation_full,
  54 
  55     _cms_generation_full,
  56     _cms_initial_mark,
  57     _cms_final_remark,
  58 
  59     _old_generation_expanded_on_last_scavenge,
  60     _old_generation_too_full_to_scavenge,
  61     _adaptive_size_policy,
  62 
  63     _g1_inc_collection_pause,
  64 
  65     _last_ditch_collection,
  66     _last_gc_cause
  67   };
  68 
  69   inline static bool is_user_requested_gc(GCCause::Cause cause) {
  70     return (cause == GCCause::_java_lang_system_gc ||
  71             cause == GCCause::_jvmti_force_gc);
  72   }
  73 
  74   inline static bool is_serviceability_requested_gc(GCCause::Cause
  75                                                              cause) {
  76     return (cause == GCCause::_jvmti_force_gc ||
  77             cause == GCCause::_heap_inspection ||
  78             cause == GCCause::_heap_dump);
  79   }
  80 
  81   // Return a string describing the GCCause.
  82   static const char* to_string(GCCause::Cause cause);
  83   // Return true if the GCCause is for a full collection.
  84   static bool is_for_full_collection(GCCause::Cause cause) PRODUCT_RETURN0;
  85 };