1/*
2 * Copyright (c) 2002, 2019, 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_GC_SHARED_GCCAUSE_HPP
26#define SHARE_GC_SHARED_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 implementation-private "causes".
35//
36// The definitions in the SA code should be kept in sync
37// with the definitions here.
38//
39
40class GCCause : public AllStatic {
41 public:
42 enum Cause {
43 /* public */
44 _java_lang_system_gc,
45 _full_gc_alot,
46 _scavenge_alot,
47 _allocation_profiler,
48 _jvmti_force_gc,
49 _gc_locker,
50 _heap_inspection,
51 _heap_dump,
52 _wb_young_gc,
53 _wb_conc_mark,
54 _wb_full_gc,
55 _archive_time_gc,
56
57 /* implementation independent, but reserved for GC use */
58 _no_gc,
59 _no_cause_specified,
60 _allocation_failure,
61
62 /* implementation specific */
63
64 _tenured_generation_full,
65 _metadata_GC_threshold,
66 _metadata_GC_clear_soft_refs,
67
68 _cms_generation_full,
69 _cms_initial_mark,
70 _cms_final_remark,
71 _cms_concurrent_mark,
72
73 _old_generation_expanded_on_last_scavenge,
74 _old_generation_too_full_to_scavenge,
75 _adaptive_size_policy,
76
77 _g1_inc_collection_pause,
78 _g1_humongous_allocation,
79 _g1_periodic_collection,
80
81 _dcmd_gc_run,
82
83 _shenandoah_stop_vm,
84 _shenandoah_allocation_failure_evac,
85 _shenandoah_concurrent_gc,
86 _shenandoah_traversal_gc,
87 _shenandoah_upgrade_to_full_gc,
88
89 _z_timer,
90 _z_warmup,
91 _z_allocation_rate,
92 _z_allocation_stall,
93 _z_proactive,
94 _z_high_usage,
95
96 _last_gc_cause
97 };
98
99 inline static bool is_user_requested_gc(GCCause::Cause cause) {
100 return (cause == GCCause::_java_lang_system_gc ||
101 cause == GCCause::_dcmd_gc_run);
102 }
103
104 inline static bool is_serviceability_requested_gc(GCCause::Cause
105 cause) {
106 return (cause == GCCause::_jvmti_force_gc ||
107 cause == GCCause::_heap_inspection ||
108 cause == GCCause::_heap_dump);
109 }
110
111 // Causes for collection of the tenured gernation
112 inline static bool is_tenured_allocation_failure_gc(GCCause::Cause cause) {
113 assert(cause != GCCause::_old_generation_too_full_to_scavenge &&
114 cause != GCCause::_old_generation_expanded_on_last_scavenge,
115 "This GCCause may be correct but is not expected yet: %s",
116 to_string(cause));
117 // _tenured_generation_full or _cms_generation_full for full tenured generations
118 // _adaptive_size_policy for a full collection after a young GC
119 // _allocation_failure is the generic cause a collection which could result
120 // in the collection of the tenured generation if there is not enough space
121 // in the tenured generation to support a young GC.
122 return (cause == GCCause::_tenured_generation_full ||
123 cause == GCCause::_cms_generation_full ||
124 cause == GCCause::_adaptive_size_policy ||
125 cause == GCCause::_allocation_failure);
126 }
127
128 // Causes for collection of the young generation
129 inline static bool is_allocation_failure_gc(GCCause::Cause cause) {
130 // _allocation_failure is the generic cause a collection for allocation failure
131 // _adaptive_size_policy is for a collecton done before a full GC
132 return (cause == GCCause::_allocation_failure ||
133 cause == GCCause::_adaptive_size_policy ||
134 cause == GCCause::_shenandoah_allocation_failure_evac);
135 }
136
137 // Return a string describing the GCCause.
138 static const char* to_string(GCCause::Cause cause);
139};
140
141#endif // SHARE_GC_SHARED_GCCAUSE_HPP
142