1 /*
 2  * Copyright (c) 2013, 2021, Red Hat, Inc. 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_SHENANDOAH_SHENANDOAHCOLLECTORPOLICY_HPP
26 #define SHARE_GC_SHENANDOAH_SHENANDOAHCOLLECTORPOLICY_HPP
27 
28 #include "gc/shared/gcTrace.hpp"
29 #include "gc/shenandoah/shenandoahGC.hpp"
30 #include "gc/shenandoah/shenandoahSharedVariables.hpp"
31 #include "memory/allocation.hpp"
32 #include "utilities/ostream.hpp"
33 
34 class ShenandoahTracer : public GCTracer, public CHeapObj<mtGC> {
35 public:
36   ShenandoahTracer() : GCTracer(Shenandoah) {}
37 };
38 
39 class ShenandoahCollectorPolicy : public CHeapObj<mtGC> {
40 private:
41   size_t _success_concurrent_gcs;
42   size_t _success_degenerated_gcs;
43   // Written by control thread, read by mutators
44   volatile size_t _success_full_gcs;
45   size_t _alloc_failure_degenerated;
46   size_t _alloc_failure_degenerated_upgrade_to_full;
47   size_t _alloc_failure_full;
48   size_t _explicit_concurrent;
49   size_t _explicit_full;
50   size_t _implicit_concurrent;
51   size_t _implicit_full;
52   size_t _degen_points[ShenandoahGC::_DEGENERATED_LIMIT];
53 
54   ShenandoahSharedFlag _in_shutdown;
55 
56   ShenandoahTracer* _tracer;
57 
58   size_t _cycle_counter;
59 
60 public:
61   ShenandoahCollectorPolicy();
62 
63   // TODO: This is different from gc_end: that one encompasses one VM operation.
64   // These two encompass the entire cycle.
65   void record_cycle_start();
66 
67   void record_success_concurrent();
68   void record_success_degenerated();
69   void record_success_full();
70   void record_alloc_failure_to_degenerated(ShenandoahGC::ShenandoahDegenPoint point);
71   void record_alloc_failure_to_full();
72   void record_degenerated_upgrade_to_full();
73   void record_explicit_to_concurrent();
74   void record_explicit_to_full();
75   void record_implicit_to_concurrent();
76   void record_implicit_to_full();
77 
78   void record_shutdown();
79   bool is_at_shutdown();
80 
81   ShenandoahTracer* tracer() {return _tracer;}
82 
83   size_t cycle_counter() const;
84 
85   void print_gc_stats(outputStream* out) const;
86 
87   size_t full_gc_count() const {
88     return _success_full_gcs + _alloc_failure_degenerated_upgrade_to_full;
89   }
90 };
91 
92 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHCOLLECTORPOLICY_HPP