1 /* 2 * Copyright (c) 2002, 2015, 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_VM_MEMORY_HEAPINSPECTION_HPP 26 #define SHARE_VM_MEMORY_HEAPINSPECTION_HPP 27 28 #include "memory/allocation.inline.hpp" 29 #include "oops/oop.inline.hpp" 30 #include "oops/annotations.hpp" 31 #include "utilities/macros.hpp" 32 33 #if INCLUDE_SERVICES 34 35 36 // HeapInspection 37 38 // KlassInfoTable is a bucket hash table that 39 // maps Klass*s to extra information: 40 // instance count and instance word size. 41 // 42 // A KlassInfoBucket is the head of a link list 43 // of KlassInfoEntry's 44 // 45 // KlassInfoHisto is a growable array of pointers 46 // to KlassInfoEntry's and is used to sort 47 // the entries. 48 49 #define HEAP_INSPECTION_COLUMNS_DO(f) \ 50 f(inst_size, InstSize, \ 51 "Size of each object instance of the Java class") \ 52 f(inst_count, InstCount, \ 53 "Number of object instances of the Java class") \ 54 f(inst_bytes, InstBytes, \ 55 "This is usually (InstSize * InstNum). The only exception is " \ 56 "java.lang.Class, whose InstBytes also includes the slots " \ 57 "used to store static fields. InstBytes is not counted in " \ 58 "ROAll, RWAll or Total") \ 59 f(mirror_bytes, Mirror, \ 60 "Size of the Klass::java_mirror() object") \ 61 f(klass_bytes, KlassBytes, \ 62 "Size of the InstanceKlass or ArrayKlass for this class. " \ 63 "Note that this includes VTab, ITab, OopMap") \ 64 f(secondary_supers_bytes, K_secondary_supers, \ 65 "Number of bytes used by the Klass::secondary_supers() array") \ 66 f(vtab_bytes, VTab, \ 67 "Size of the embedded vtable in InstanceKlass") \ 68 f(itab_bytes, ITab, \ 69 "Size of the embedded itable in InstanceKlass") \ 70 f(nonstatic_oopmap_bytes, OopMap, \ 71 "Size of the embedded nonstatic_oop_map in InstanceKlass") \ 72 f(methods_array_bytes, IK_methods, \ 73 "Number of bytes used by the InstanceKlass::methods() array") \ 74 f(method_ordering_bytes, IK_method_ordering, \ 75 "Number of bytes used by the InstanceKlass::method_ordering() array") \ 76 f(default_methods_array_bytes, IK_default_methods, \ 77 "Number of bytes used by the InstanceKlass::default_methods() array") \ 78 f(default_vtable_indices_bytes, IK_default_vtable_indices, \ 79 "Number of bytes used by the InstanceKlass::default_vtable_indices() array") \ 80 f(local_interfaces_bytes, IK_local_interfaces, \ 81 "Number of bytes used by the InstanceKlass::local_interfaces() array") \ 82 f(transitive_interfaces_bytes, IK_transitive_interfaces, \ 83 "Number of bytes used by the InstanceKlass::transitive_interfaces() array") \ 84 f(fields_bytes, IK_fields, \ 85 "Number of bytes used by the InstanceKlass::fields() array") \ 86 f(inner_classes_bytes, IK_inner_classes, \ 87 "Number of bytes used by the InstanceKlass::inner_classes() array") \ 88 f(signers_bytes, IK_signers, \ 89 "Number of bytes used by the InstanceKlass::singers() array") \ 90 f(class_annotations_bytes, class_annotations, \ 91 "Size of class annotations") \ 92 f(class_type_annotations_bytes, class_type_annotations, \ 93 "Size of class type annotations") \ 94 f(fields_annotations_bytes, fields_annotations, \ 95 "Size of field annotations") \ 96 f(fields_type_annotations_bytes, fields_type_annotations, \ 97 "Size of field type annotations") \ 98 f(methods_annotations_bytes, methods_annotations, \ 99 "Size of method annotations") \ 100 f(methods_parameter_annotations_bytes, methods_parameter_annotations, \ 101 "Size of method parameter annotations") \ 102 f(methods_type_annotations_bytes, methods_type_annotations, \ 103 "Size of methods type annotations") \ 104 f(methods_default_annotations_bytes, methods_default_annotations, \ 105 "Size of methods default annotations") \ 106 f(annotations_bytes, annotations, \ 107 "Size of all annotations") \ 108 f(cp_bytes, Cp, \ 109 "Size of InstanceKlass::constants()") \ 110 f(cp_tags_bytes, CpTags, \ 111 "Size of InstanceKlass::constants()->tags()") \ 112 f(cp_cache_bytes, CpCache, \ 113 "Size of InstanceKlass::constants()->cache()") \ 114 f(cp_operands_bytes, CpOperands, \ 115 "Size of InstanceKlass::constants()->operands()") \ 116 f(cp_refmap_bytes, CpRefMap, \ 117 "Size of InstanceKlass::constants()->reference_map()") \ 118 f(cp_all_bytes, CpAll, \ 119 "Sum of Cp + CpTags + CpCache + CpOperands + CpRefMap") \ 120 f(method_count, MethodCount, \ 121 "Number of methods in this class") \ 122 f(method_bytes, MethodBytes, \ 123 "Size of the Method object") \ 124 f(const_method_bytes, ConstMethod, \ 125 "Size of the ConstMethod object") \ 126 f(method_data_bytes, MethodData, \ 127 "Size of the MethodData object") \ 128 f(stackmap_bytes, StackMap, \ 129 "Size of the stackmap_data") \ 130 f(bytecode_bytes, Bytecodes, \ 131 "Of the MethodBytes column, how much are the space taken up by bytecodes") \ 132 f(method_all_bytes, MethodAll, \ 133 "Sum of MethodBytes + Constmethod + Stackmap + Methoddata") \ 134 f(ro_bytes, ROAll, \ 135 "Size of all class meta data that could (potentially) be placed " \ 136 "in read-only memory. (This could change with CDS design)") \ 137 f(rw_bytes, RWAll, \ 138 "Size of all class meta data that must be placed in read/write " \ 139 "memory. (This could change with CDS design) ") \ 140 f(total_bytes, Total, \ 141 "ROAll + RWAll. Note that this does NOT include InstBytes.") 142 143 // Size statistics for a Klass - filled in by Klass::collect_statistics() 144 class KlassSizeStats { 145 public: 146 #define COUNT_KLASS_SIZE_STATS_FIELD(field, name, help) _index_ ## field, 147 #define DECLARE_KLASS_SIZE_STATS_FIELD(field, name, help) julong _ ## field; 148 149 enum { 150 HEAP_INSPECTION_COLUMNS_DO(COUNT_KLASS_SIZE_STATS_FIELD) 151 _num_columns 152 }; 153 154 HEAP_INSPECTION_COLUMNS_DO(DECLARE_KLASS_SIZE_STATS_FIELD) 155 156 static int count(oop x) { 157 return (HeapWordSize * (((x) != NULL) ? (x)->size() : 0)); 158 } 159 160 static int count_array(objArrayOop x) { 161 return (HeapWordSize * (((x) != NULL) ? (x)->size() : 0)); 162 } 163 164 template <class T> static int count(T* x) { 165 return (HeapWordSize * ((x) ? (x)->size() : 0)); 166 } 167 168 template <class T> static int count_array(T* x) { 169 if (x == NULL) { 170 return 0; 171 } 172 if (x->length() == 0) { 173 // This is a shared array, e.g., Universe::the_empty_int_array(). Don't 174 // count it to avoid double-counting. 175 return 0; 176 } 177 return HeapWordSize * x->size(); 178 } 179 }; 180 181 182 183 184 class KlassInfoEntry: public CHeapObj<mtInternal> { 185 private: 186 KlassInfoEntry* _next; 187 Klass* _klass; 188 long _instance_count; 189 size_t _instance_words; 190 long _index; 191 bool _do_print; // True if we should print this class when printing the class hierarchy. 192 GrowableArray<KlassInfoEntry*>* _subclasses; 193 194 public: 195 KlassInfoEntry(Klass* k, KlassInfoEntry* next) : 196 _klass(k), _instance_count(0), _instance_words(0), _next(next), _index(-1), 197 _do_print(false), _subclasses(NULL) 198 {} 199 ~KlassInfoEntry(); 200 KlassInfoEntry* next() const { return _next; } 201 bool is_equal(const Klass* k) { return k == _klass; } 202 Klass* klass() const { return _klass; } 203 long count() const { return _instance_count; } 204 void set_count(long ct) { _instance_count = ct; } 205 size_t words() const { return _instance_words; } 206 void set_words(size_t wds) { _instance_words = wds; } 207 void set_index(long index) { _index = index; } 208 long index() const { return _index; } 209 GrowableArray<KlassInfoEntry*>* subclasses() const { return _subclasses; } 210 void add_subclass(KlassInfoEntry* cie); 211 void set_do_print(bool do_print) { _do_print = do_print; } 212 bool do_print() const { return _do_print; } 213 int compare(KlassInfoEntry* e1, KlassInfoEntry* e2); 214 void print_on(outputStream* st) const; 215 const char* name() const; 216 }; 217 218 class KlassInfoClosure : public StackObj { 219 public: 220 // Called for each KlassInfoEntry. 221 virtual void do_cinfo(KlassInfoEntry* cie) = 0; 222 }; 223 224 class KlassInfoBucket: public CHeapObj<mtInternal> { 225 private: 226 KlassInfoEntry* _list; 227 KlassInfoEntry* list() { return _list; } 228 void set_list(KlassInfoEntry* l) { _list = l; } 229 public: 230 KlassInfoEntry* lookup(Klass* k); 231 void initialize() { _list = NULL; } 232 void empty(); 233 void iterate(KlassInfoClosure* cic); 234 }; 235 236 class KlassInfoTable: public StackObj { 237 private: 238 int _size; 239 static const int _num_buckets = 20011; 240 size_t _size_of_instances_in_words; 241 242 // An aligned reference address (typically the least 243 // address in the perm gen) used for hashing klass 244 // objects. 245 HeapWord* _ref; 246 247 KlassInfoBucket* _buckets; 248 uint hash(const Klass* p); 249 KlassInfoEntry* lookup(Klass* k); // allocates if not found! 250 251 class AllClassesFinder : public KlassClosure { 252 KlassInfoTable *_table; 253 public: 254 AllClassesFinder(KlassInfoTable* table) : _table(table) {} 255 virtual void do_klass(Klass* k); 256 }; 257 258 public: 259 KlassInfoTable(bool add_all_classes); 260 ~KlassInfoTable(); 261 bool record_instance(const oop obj); 262 void iterate(KlassInfoClosure* cic); 263 bool allocation_failed() { return _buckets == NULL; } 264 size_t size_of_instances_in_words() const; 265 266 friend class KlassInfoHisto; 267 friend class KlassHierarchy; 268 }; 269 270 class KlassHierarchy : public StackObj { 271 public: 272 KlassHierarchy(KlassInfoTable* cit, const char* title); 273 ~KlassHierarchy(); 274 static void print_class_hierarchy(outputStream* st, bool print_interfaces, bool print_subclasses, 275 char* classname); 276 277 private: 278 static void set_do_print_for_class_hierarchy(KlassInfoEntry* cie, KlassInfoTable* cit, 279 bool print_subclasse); 280 static void print_class(outputStream* st, KlassInfoEntry* cie, bool print_subclasses); 281 }; 282 283 class KlassInfoHisto : public StackObj { 284 private: 285 static const int _histo_initial_size = 1000; 286 KlassInfoTable *_cit; 287 GrowableArray<KlassInfoEntry*>* _elements; 288 GrowableArray<KlassInfoEntry*>* elements() const { return _elements; } 289 const char* _title; 290 const char* title() const { return _title; } 291 static int sort_helper(KlassInfoEntry** e1, KlassInfoEntry** e2); 292 void print_elements(outputStream* st) const; 293 void print_class_stats(outputStream* st, bool csv_format, const char *columns); 294 julong annotations_bytes(Array<AnnotationArray*>* p) const; 295 const char *_selected_columns; 296 bool is_selected(const char *col_name); 297 void print_title(outputStream* st, bool csv_format, 298 bool selected_columns_table[], int width_table[], 299 const char *name_table[]); 300 301 template <class T> static int count_bytes(T* x) { 302 return (HeapWordSize * ((x) ? (x)->size() : 0)); 303 } 304 305 template <class T> static int count_bytes_array(T* x) { 306 if (x == NULL) { 307 return 0; 308 } 309 if (x->length() == 0) { 310 // This is a shared array, e.g., Universe::the_empty_int_array(). Don't 311 // count it to avoid double-counting. 312 return 0; 313 } 314 return HeapWordSize * x->size(); 315 } 316 317 // returns a format string to print a julong with the given width. E.g, 318 // printf(num_fmt(6), julong(10)) would print out the number 10 with 4 319 // leading spaces. 320 PRAGMA_DIAG_PUSH 321 PRAGMA_FORMAT_NONLITERAL_IGNORED 322 323 static void print_julong(outputStream* st, int width, julong n) { 324 int num_spaces = width - julong_width(n); 325 if (num_spaces > 0) { 326 st->print(str_fmt(num_spaces), ""); 327 } 328 st->print(JULONG_FORMAT, n); 329 } 330 PRAGMA_DIAG_POP 331 332 static char* perc_fmt(int width) { 333 static char buf[32]; 334 jio_snprintf(buf, sizeof(buf), "%%%d.1f%%%%", width-1); 335 return buf; 336 } 337 338 static char* str_fmt(int width) { 339 static char buf[32]; 340 jio_snprintf(buf, sizeof(buf), "%%%ds", width); 341 return buf; 342 } 343 344 static int julong_width(julong n) { 345 if (n == 0) { 346 return 1; 347 } 348 int w = 0; 349 while (n > 0) { 350 n /= 10; 351 w += 1; 352 } 353 return w; 354 } 355 356 static int col_width(julong n, const char *name) { 357 int w = julong_width(n); 358 int min = (int)(strlen(name)); 359 if (w < min) { 360 w = min; 361 } 362 // add a leading space for separation. 363 return w + 1; 364 } 365 366 public: 367 KlassInfoHisto(KlassInfoTable* cit, const char* title); 368 ~KlassInfoHisto(); 369 void add(KlassInfoEntry* cie); 370 void print_histo_on(outputStream* st, bool print_class_stats, bool csv_format, const char *columns); 371 void sort(); 372 }; 373 374 #endif // INCLUDE_SERVICES 375 376 // These declarations are needed since the declaration of KlassInfoTable and 377 // KlassInfoClosure are guarded by #if INLCUDE_SERVICES 378 class KlassInfoTable; 379 class KlassInfoClosure; 380 381 class HeapInspection : public StackObj { 382 bool _csv_format; // "comma separated values" format for spreadsheet. 383 bool _print_help; 384 bool _print_class_stats; 385 const char* _columns; 386 public: 387 HeapInspection(bool csv_format, bool print_help, 388 bool print_class_stats, const char *columns) : 389 _csv_format(csv_format), _print_help(print_help), 390 _print_class_stats(print_class_stats), _columns(columns) {} 391 void heap_inspection(outputStream* st) NOT_SERVICES_RETURN; 392 size_t populate_table(KlassInfoTable* cit, BoolObjectClosure* filter = NULL) NOT_SERVICES_RETURN_(0); 393 static void find_instances_at_safepoint(Klass* k, GrowableArray<oop>* result) NOT_SERVICES_RETURN; 394 private: 395 void iterate_over_heap(KlassInfoTable* cit, BoolObjectClosure* filter = NULL); 396 }; 397 398 #endif // SHARE_VM_MEMORY_HEAPINSPECTION_HPP