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