1 /*
 2  * Copyright (c) 2016, 2019, 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_SHENANDOAHHEAPREGIONCOUNTERS_HPP
26 #define SHARE_GC_SHENANDOAH_SHENANDOAHHEAPREGIONCOUNTERS_HPP
27 
28 #include "memory/allocation.hpp"
29 
30 /**
31  * This provides the following in JVMStat:
32  *
33  * constants:
34  * - sun.gc.shenandoah.regions.timestamp    the timestamp for this sample
35  * - sun.gc.shenandoah.regions.max_regions  maximum number of regions
36  * - sun.gc.shenandoah.regions.region_size  size per region, in kilobytes
37  *
38  * variables:
39  * - sun.gc.shenandoah.regions.status       current GC status:
40  *     - bit 0 set when marking in progress
41  *     - bit 1 set when evacuation in progress
42  *     - bit 2 set when update refs in progress
43  *
44  * two variable counters per region, with $max_regions (see above) counters:
45  * - sun.gc.shenandoah.regions.region.$i.data
46  * where $ is the region number from 0 <= i < $max_regions
47  *
48  * .data is in the following format:
49  * - bits 0-6    used memory in percent
50  * - bits 7-13   live memory in percent
51  * - bits 14-20  tlab allocated memory in percent
52  * - bits 21-27  gclab allocated memory in percent
53  * - bits 28-34  shared allocated memory in percent
54  * - bits 35-41  <reserved>
55  * - bits 42-50  <reserved>
56  * - bits 51-57  <reserved>
57  * - bits 58-63  status
58  *      - bits describe the state as recorded in ShenandoahHeapRegion
59  */
60 class ShenandoahHeapRegionCounters : public CHeapObj<mtGC>  {
61 private:
62   static const jlong PERCENT_MASK = 0x7f;
63   static const jlong STATUS_MASK  = 0x3f;
64 
65   static const jlong USED_SHIFT   = 0;
66   static const jlong LIVE_SHIFT   = 7;
67   static const jlong TLAB_SHIFT   = 14;
68   static const jlong GCLAB_SHIFT  = 21;
69   static const jlong SHARED_SHIFT = 28;
70 
71   static const jlong STATUS_SHIFT = 58;
72 
73   char* _name_space;
74   PerfLongVariable** _regions_data;
75   PerfLongVariable* _timestamp;
76   PerfLongVariable* _status;
77   volatile jlong _last_sample_millis;
78 
79 public:
80   ShenandoahHeapRegionCounters();
81   ~ShenandoahHeapRegionCounters();
82   void update();
83 };
84 
85 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHHEAPREGIONCOUNTERS_HPP