1 /*
  2  * Copyright (c) 2020, 2026, 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_CDS_DUMPALLOCSTATS_HPP
 26 #define SHARE_CDS_DUMPALLOCSTATS_HPP
 27 
 28 #include "classfile/compactHashtable.hpp"
 29 #include "memory/allocation.hpp"
 30 #include "memory/metaspaceClosureType.hpp"
 31 
 32 // This is for dumping detailed statistics for the allocations
 33 // in the shared spaces.
 34 class DumpAllocStats : public StackObj {
 35 public:
 36 
 37 #define DUMPED_OBJ_TYPES_DO(f) \
 38   METASPACE_CLOSURE_TYPES_DO(f) \
 39   f(SymbolHashentry) \
 40   f(SymbolBucket) \
 41   f(StringHashentry) \
 42   f(StringBucket) \
 43   f(CppVTables) \
 44   f(Other)
 45 
 46 #define DUMPED_TYPE_DECLARE(name) name ## Type,
 47 #define DUMPED_TYPE_NAME_CASE(name) case name ## Type: return #name;
 48 
 49   enum Type {
 50     // Types are MetaspaceObj::ClassType, MetaspaceObj::SymbolType, etc
 51     DUMPED_OBJ_TYPES_DO(DUMPED_TYPE_DECLARE)
 52     _number_of_types
 53   };
 54 
 55   static const char* type_name(Type type) {
 56     switch(type) {
 57     DUMPED_OBJ_TYPES_DO(DUMPED_TYPE_NAME_CASE)
 58     default:
 59       ShouldNotReachHere();
 60       return nullptr;
 61     }
 62   }
 63 
 64   CompactHashtableStats _symbol_stats;
 65   CompactHashtableStats _string_stats;
 66 
 67   int _counts[2][_number_of_types];
 68   int _bytes [2][_number_of_types];
 69 
 70   int _num_field_cp_entries;
 71   int _num_field_cp_entries_archived;
 72   int _num_field_cp_entries_reverted;
 73   int _num_indy_cp_entries;
 74   int _num_indy_cp_entries_archived;
 75   int _num_indy_cp_entries_reverted;
 76   int _num_klass_cp_entries;
 77   int _num_klass_cp_entries_archived;
 78   int _num_klass_cp_entries_reverted;
 79   int _num_method_cp_entries;
 80   int _num_method_cp_entries_archived;
 81   int _num_method_cp_entries_reverted;
 82 
 83 public:
 84   enum { RO = 0, RW = 1 };
 85 
 86   DumpAllocStats() {
 87     memset(_counts, 0, sizeof(_counts));
 88     memset(_bytes,  0, sizeof(_bytes));
 89     _num_field_cp_entries           = 0;
 90     _num_field_cp_entries_archived  = 0;
 91     _num_field_cp_entries_reverted  = 0;
 92     _num_indy_cp_entries            = 0;
 93     _num_indy_cp_entries_archived   = 0;
 94     _num_indy_cp_entries_reverted   = 0;
 95     _num_klass_cp_entries           = 0;
 96     _num_klass_cp_entries_archived  = 0;
 97     _num_klass_cp_entries_reverted  = 0;
 98     _num_method_cp_entries          = 0;
 99     _num_method_cp_entries_archived = 0;
100     _num_method_cp_entries_reverted = 0;
101   };
102 
103   CompactHashtableStats* symbol_stats() { return &_symbol_stats; }
104   CompactHashtableStats* string_stats() { return &_string_stats; }
105 
106   void record(MetaspaceClosureType type, int byte_size, bool read_only) {
107     int t = (int)type;
108     assert(t >= 0 && t < (int)MetaspaceClosureType::_number_of_types, "sanity");
109     int which = (read_only) ? RO : RW;
110     _counts[which][t] ++;
111     _bytes [which][t] += byte_size;
112   }
113 
114   void record_other_type(int byte_size, bool read_only) {
115     int which = (read_only) ? RO : RW;
116     _bytes [which][OtherType] += byte_size;
117   }
118 
119   void record_cpp_vtables(int byte_size) {
120     _bytes[RW][CppVTablesType] += byte_size;
121   }
122 
123   void record_field_cp_entry(bool archived, bool reverted) {
124     _num_field_cp_entries ++;
125     _num_field_cp_entries_archived += archived ? 1 : 0;
126     _num_field_cp_entries_reverted += reverted ? 1 : 0;
127   }
128 
129   void record_indy_cp_entry(bool archived, bool reverted) {
130     _num_indy_cp_entries ++;
131     _num_indy_cp_entries_archived += archived ? 1 : 0;
132     _num_indy_cp_entries_reverted += reverted ? 1 : 0;
133   }
134 
135   void record_klass_cp_entry(bool archived, bool reverted) {
136     _num_klass_cp_entries ++;
137     _num_klass_cp_entries_archived += archived ? 1 : 0;
138     _num_klass_cp_entries_reverted += reverted ? 1 : 0;
139   }
140 
141   void record_method_cp_entry(bool archived, bool reverted) {
142     _num_method_cp_entries ++;
143     _num_method_cp_entries_archived += archived ? 1 : 0;
144     _num_method_cp_entries_reverted += reverted ? 1 : 0;
145   }
146 
147   void print_stats(int ro_all, int rw_all);
148 
149   DEBUG_ONLY(void verify(int expected_byte_size, bool read_only) const);
150 
151 };
152 
153 #endif // SHARE_CDS_DUMPALLOCSTATS_HPP