1 /* 2 * Copyright (c) 2002, 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 #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 50 /* implementation independent, but reserved for GC use */ 51 _no_gc, 52 _no_cause_specified, 53 _allocation_failure, 54 55 /* implementation specific */ 56 57 _tenured_generation_full, 58 _metadata_GC_threshold, 59 60 _cms_generation_full, 61 _cms_initial_mark, 62 _cms_final_remark, 63 64 _old_generation_expanded_on_last_scavenge, 65 _old_generation_too_full_to_scavenge, 66 _adaptive_size_policy, 67 68 _g1_inc_collection_pause, 69 _g1_humongous_allocation, 70 71 _last_ditch_collection, 72 _last_gc_cause 73 }; 74 75 inline static bool is_user_requested_gc(GCCause::Cause cause) { 76 return (cause == GCCause::_java_lang_system_gc || 77 cause == GCCause::_jvmti_force_gc); 78 } 79 80 inline static bool is_serviceability_requested_gc(GCCause::Cause 81 cause) { 82 return (cause == GCCause::_jvmti_force_gc || 83 cause == GCCause::_heap_inspection || 84 cause == GCCause::_heap_dump); 85 } 86 87 // Return a string describing the GCCause. 88 static const char* to_string(GCCause::Cause cause); 89 }; 90 91 // Helper class for doing logging that includes the GC Cause 92 // as a string. 93 class GCCauseString : StackObj { 94 private: 95 static const int _length = 128; 96 char _buffer[_length]; 97 int _position; 98 99 public: 100 GCCauseString(const char* prefix, GCCause::Cause cause) { 101 if (PrintGCCause) { 102 _position = jio_snprintf(_buffer, _length, "%s (%s) ", prefix, GCCause::to_string(cause)); 103 } else { 104 _position = jio_snprintf(_buffer, _length, "%s ", prefix); 105 } 106 assert(_position >= 0 && _position <= _length, 107 err_msg("Need to increase the buffer size in GCCauseString? %d", _position)); 108 } 109 110 GCCauseString& append(const char* str) { 111 int res = jio_snprintf(_buffer + _position, _length - _position, "%s", str); 112 _position += res; 113 assert(res >= 0 && _position <= _length, 114 err_msg("Need to increase the buffer size in GCCauseString? %d", res)); 115 return *this; 116 } 117 118 operator const char*() { 119 return _buffer; 120 } 121 }; 122 123 #endif // SHARE_VM_GC_INTERFACE_GCCAUSE_HPP