1 /*
2 * Copyright (c) 2002, 2014, 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 #include "precompiled.hpp"
26 #include "classfile/classLoaderData.hpp"
27 #include "gc_interface/collectedHeap.hpp"
28 #include "memory/genCollectedHeap.hpp"
29 #include "memory/heapInspection.hpp"
30 #include "memory/resourceArea.hpp"
31 #include "oops/oop.inline.hpp"
32 #include "runtime/os.hpp"
33 #include "utilities/globalDefinitions.hpp"
34 #include "utilities/macros.hpp"
35 #if INCLUDE_ALL_GCS
36 #include "gc_implementation/parallelScavenge/parallelScavengeHeap.hpp"
37 #endif // INCLUDE_ALL_GCS
38
39 PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC
40
41 // HeapInspection
42
43 int KlassInfoEntry::compare(KlassInfoEntry* e1, KlassInfoEntry* e2) {
44 if(e1->_instance_words > e2->_instance_words) {
45 return -1;
46 } else if(e1->_instance_words < e2->_instance_words) {
47 return 1;
48 }
49 // Sort alphabetically, note 'Z' < '[' < 'a', but it's better to group
50 // the array classes before all the instance classes.
51 ResourceMark rm;
52 const char* name1 = e1->klass()->external_name();
53 const char* name2 = e2->klass()->external_name();
54 bool d1 = (name1[0] == '[');
55 bool d2 = (name2[0] == '[');
56 if (d1 && !d2) {
57 return -1;
58 } else if (d2 && !d1) {
59 return 1;
60 } else {
61 return strcmp(name1, name2);
62 }
63 }
64
65 const char* KlassInfoEntry::name() const {
66 const char* name;
67 if (_klass->name() != NULL) {
68 name = _klass->external_name();
69 } else {
70 if (_klass == Universe::boolArrayKlassObj()) name = "<boolArrayKlass>"; else
71 if (_klass == Universe::charArrayKlassObj()) name = "<charArrayKlass>"; else
72 if (_klass == Universe::singleArrayKlassObj()) name = "<singleArrayKlass>"; else
73 if (_klass == Universe::doubleArrayKlassObj()) name = "<doubleArrayKlass>"; else
74 if (_klass == Universe::byteArrayKlassObj()) name = "<byteArrayKlass>"; else
75 if (_klass == Universe::shortArrayKlassObj()) name = "<shortArrayKlass>"; else
76 if (_klass == Universe::intArrayKlassObj()) name = "<intArrayKlass>"; else
77 if (_klass == Universe::longArrayKlassObj()) name = "<longArrayKlass>"; else
78 name = "<no name>";
79 }
80 return name;
81 }
82
83 void KlassInfoEntry::print_on(outputStream* st) const {
84 ResourceMark rm;
85
86 // simplify the formatting (ILP32 vs LP64) - always cast the numbers to 64-bit
87 st->print_cr(INT64_FORMAT_W(13) " " UINT64_FORMAT_W(13) " %s",
88 (jlong) _instance_count,
89 (julong) _instance_words * HeapWordSize,
90 name());
91 }
92
93 KlassInfoEntry* KlassInfoBucket::lookup(Klass* const k) {
94 KlassInfoEntry* elt = _list;
95 while (elt != NULL) {
96 if (elt->is_equal(k)) {
97 return elt;
98 }
99 elt = elt->next();
100 }
101 elt = new (std::nothrow) KlassInfoEntry(k, list());
102 // We may be out of space to allocate the new entry.
103 if (elt != NULL) {
104 set_list(elt);
105 }
106 return elt;
107 }
108
109 void KlassInfoBucket::iterate(KlassInfoClosure* cic) {
110 KlassInfoEntry* elt = _list;
111 while (elt != NULL) {
112 cic->do_cinfo(elt);
113 elt = elt->next();
114 }
115 }
116
117 void KlassInfoBucket::empty() {
118 KlassInfoEntry* elt = _list;
119 _list = NULL;
120 while (elt != NULL) {
121 KlassInfoEntry* next = elt->next();
122 delete elt;
123 elt = next;
124 }
125 }
126
127 void KlassInfoTable::AllClassesFinder::do_klass(Klass* k) {
128 // This has the SIDE EFFECT of creating a KlassInfoEntry
129 // for <k>, if one doesn't exist yet.
130 _table->lookup(k);
131 }
132
133 KlassInfoTable::KlassInfoTable(bool need_class_stats) {
134 _size_of_instances_in_words = 0;
135 _size = 0;
136 _ref = (HeapWord*) Universe::boolArrayKlassObj();
137 _buckets =
138 (KlassInfoBucket*) AllocateHeap(sizeof(KlassInfoBucket) * _num_buckets,
139 mtInternal, CURRENT_PC, AllocFailStrategy::RETURN_NULL);
140 if (_buckets != NULL) {
141 _size = _num_buckets;
142 for (int index = 0; index < _size; index++) {
143 _buckets[index].initialize();
144 }
145 if (need_class_stats) {
146 AllClassesFinder finder(this);
147 ClassLoaderDataGraph::classes_do(&finder);
148 }
149 }
150 }
151
152 KlassInfoTable::~KlassInfoTable() {
153 if (_buckets != NULL) {
154 for (int index = 0; index < _size; index++) {
155 _buckets[index].empty();
156 }
157 FREE_C_HEAP_ARRAY(KlassInfoBucket, _buckets);
158 _size = 0;
159 }
160 }
161
162 uint KlassInfoTable::hash(const Klass* p) {
163 return (uint)(((uintptr_t)p - (uintptr_t)_ref) >> 2);
164 }
165
166 KlassInfoEntry* KlassInfoTable::lookup(Klass* k) {
167 uint idx = hash(k) % _size;
168 assert(_buckets != NULL, "Allocation failure should have been caught");
169 KlassInfoEntry* e = _buckets[idx].lookup(k);
170 // Lookup may fail if this is a new klass for which we
171 // could not allocate space for an new entry.
172 assert(e == NULL || k == e->klass(), "must be equal");
173 return e;
174 }
175
176 // Return false if the entry could not be recorded on account
177 // of running out of space required to create a new entry.
178 bool KlassInfoTable::record_instance(const oop obj) {
179 Klass* k = obj->klass();
180 KlassInfoEntry* elt = lookup(k);
181 // elt may be NULL if it's a new klass for which we
182 // could not allocate space for a new entry in the hashtable.
183 if (elt != NULL) {
184 elt->set_count(elt->count() + 1);
185 elt->set_words(elt->words() + obj->size());
186 _size_of_instances_in_words += obj->size();
187 return true;
188 } else {
189 return false;
190 }
191 }
192
193 void KlassInfoTable::iterate(KlassInfoClosure* cic) {
194 assert(_size == 0 || _buckets != NULL, "Allocation failure should have been caught");
195 for (int index = 0; index < _size; index++) {
196 _buckets[index].iterate(cic);
197 }
198 }
199
200 size_t KlassInfoTable::size_of_instances_in_words() const {
201 return _size_of_instances_in_words;
202 }
203
204 int KlassInfoHisto::sort_helper(KlassInfoEntry** e1, KlassInfoEntry** e2) {
205 return (*e1)->compare(*e1,*e2);
206 }
207
208 KlassInfoHisto::KlassInfoHisto(KlassInfoTable* cit, const char* title) :
209 _cit(cit),
210 _title(title) {
211 _elements = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<KlassInfoEntry*>(_histo_initial_size, true);
212 }
213
214 KlassInfoHisto::~KlassInfoHisto() {
215 delete _elements;
216 }
217
218 void KlassInfoHisto::add(KlassInfoEntry* cie) {
219 elements()->append(cie);
220 }
221
222 void KlassInfoHisto::sort() {
223 elements()->sort(KlassInfoHisto::sort_helper);
224 }
225
226 void KlassInfoHisto::print_elements(outputStream* st) const {
227 // simplify the formatting (ILP32 vs LP64) - store the sum in 64-bit
228 jlong total = 0;
229 julong totalw = 0;
230 for(int i=0; i < elements()->length(); i++) {
231 st->print("%4d: ", i+1);
232 elements()->at(i)->print_on(st);
233 total += elements()->at(i)->count();
234 totalw += elements()->at(i)->words();
235 }
236 st->print_cr("Total " INT64_FORMAT_W(13) " " UINT64_FORMAT_W(13),
237 total, totalw * HeapWordSize);
238 }
239
240 #define MAKE_COL_NAME(field, name, help) #name,
241 #define MAKE_COL_HELP(field, name, help) help,
242
243 static const char *name_table[] = {
244 HEAP_INSPECTION_COLUMNS_DO(MAKE_COL_NAME)
245 };
246
247 static const char *help_table[] = {
248 HEAP_INSPECTION_COLUMNS_DO(MAKE_COL_HELP)
249 };
250
251 bool KlassInfoHisto::is_selected(const char *col_name) {
252 if (_selected_columns == NULL) {
253 return true;
254 }
255 if (strcmp(_selected_columns, col_name) == 0) {
256 return true;
257 }
258
259 const char *start = strstr(_selected_columns, col_name);
260 if (start == NULL) {
261 return false;
262 }
263
264 // The following must be true, because _selected_columns != col_name
265 if (start > _selected_columns && start[-1] != ',') {
266 return false;
267 }
268 char x = start[strlen(col_name)];
269 if (x != ',' && x != '\0') {
270 return false;
271 }
272
273 return true;
274 }
275
276 PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL
277 void KlassInfoHisto::print_title(outputStream* st, bool csv_format,
278 bool selected[], int width_table[],
279 const char *name_table[]) {
280 if (csv_format) {
281 st->print("Index,Super");
282 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
283 if (selected[c]) {st->print(",%s", name_table[c]);}
284 }
285 st->print(",ClassName");
286 } else {
287 st->print("Index Super");
288 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
289 PRAGMA_DIAG_PUSH
290 PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
291 if (selected[c]) {st->print(str_fmt(width_table[c]), name_table[c]);}
292 PRAGMA_DIAG_POP
293 }
294 st->print(" ClassName");
295 }
296
297 if (is_selected("ClassLoader")) {
298 st->print(",ClassLoader");
299 }
300 st->cr();
301 }
302
303 void KlassInfoHisto::print_class_stats(outputStream* st,
304 bool csv_format, const char *columns) {
305 ResourceMark rm;
306 KlassSizeStats sz, sz_sum;
307 int i;
308 julong *col_table = (julong*)(&sz);
309 julong *colsum_table = (julong*)(&sz_sum);
310 int width_table[KlassSizeStats::_num_columns];
311 bool selected[KlassSizeStats::_num_columns];
312
313 _selected_columns = columns;
314
315 memset(&sz_sum, 0, sizeof(sz_sum));
316 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
317 selected[c] = is_selected(name_table[c]);
318 }
319
320 for(i=0; i < elements()->length(); i++) {
321 elements()->at(i)->set_index(i+1);
322 }
323
324 for (int pass=1; pass<=2; pass++) {
325 if (pass == 2) {
326 print_title(st, csv_format, selected, width_table, name_table);
327 }
328 for(i=0; i < elements()->length(); i++) {
329 KlassInfoEntry* e = (KlassInfoEntry*)elements()->at(i);
330 const Klass* k = e->klass();
331
332 memset(&sz, 0, sizeof(sz));
333 sz._inst_count = e->count();
334 sz._inst_bytes = HeapWordSize * e->words();
335 k->collect_statistics(&sz);
336 sz._total_bytes = sz._ro_bytes + sz._rw_bytes;
337
338 if (pass == 1) {
339 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
340 colsum_table[c] += col_table[c];
341 }
342 } else {
343 int super_index = -1;
344 if (k->oop_is_instance()) {
345 Klass* super = ((InstanceKlass*)k)->java_super();
346 if (super) {
347 KlassInfoEntry* super_e = _cit->lookup(super);
348 if (super_e) {
349 super_index = super_e->index();
350 }
351 }
352 }
353
354 if (csv_format) {
355 st->print("%d,%d", e->index(), super_index);
356 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
357 if (selected[c]) {st->print("," JULONG_FORMAT, col_table[c]);}
358 }
359 st->print(",%s",e->name());
360 } else {
361 st->print("%5d %5d", e->index(), super_index);
362 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
363 if (selected[c]) {print_julong(st, width_table[c], col_table[c]);}
364 }
365 st->print(" %s", e->name());
366 }
367 if (is_selected("ClassLoader")) {
368 ClassLoaderData* loader_data = k->class_loader_data();
369 st->print(",");
370 loader_data->print_value_on(st);
371 }
372 st->cr();
373 }
374 }
375
376 if (pass == 1) {
377 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
378 width_table[c] = col_width(colsum_table[c], name_table[c]);
379 }
380 }
381 }
382
383 sz_sum._inst_size = 0;
384
385 if (csv_format) {
386 st->print(",");
387 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
388 if (selected[c]) {st->print("," JULONG_FORMAT, colsum_table[c]);}
389 }
390 } else {
391 st->print(" ");
392 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
393 if (selected[c]) {print_julong(st, width_table[c], colsum_table[c]);}
394 }
395 st->print(" Total");
396 if (sz_sum._total_bytes > 0) {
397 st->cr();
398 st->print(" ");
399 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
400 if (selected[c]) {
401 switch (c) {
402 case KlassSizeStats::_index_inst_size:
403 case KlassSizeStats::_index_inst_count:
404 case KlassSizeStats::_index_method_count:
405 PRAGMA_DIAG_PUSH
406 PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
407 st->print(str_fmt(width_table[c]), "-");
408 PRAGMA_DIAG_POP
409 break;
410 default:
411 {
412 double perc = (double)(100) * (double)(colsum_table[c]) / (double)sz_sum._total_bytes;
413 PRAGMA_DIAG_PUSH
414 PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
415 st->print(perc_fmt(width_table[c]), perc);
416 PRAGMA_DIAG_POP
417 }
418 }
419 }
420 }
421 }
422 }
423 st->cr();
424
425 if (!csv_format) {
426 print_title(st, csv_format, selected, width_table, name_table);
427 }
428 }
429
430 julong KlassInfoHisto::annotations_bytes(Array<AnnotationArray*>* p) const {
431 julong bytes = 0;
432 if (p != NULL) {
433 for (int i = 0; i < p->length(); i++) {
434 bytes += count_bytes_array(p->at(i));
435 }
436 bytes += count_bytes_array(p);
437 }
438 return bytes;
439 }
440
441 void KlassInfoHisto::print_histo_on(outputStream* st, bool print_stats,
442 bool csv_format, const char *columns) {
443 if (print_stats) {
444 print_class_stats(st, csv_format, columns);
445 } else {
446 st->print_cr("%s",title());
447 print_elements(st);
448 }
449 }
450
451 class HistoClosure : public KlassInfoClosure {
452 private:
453 KlassInfoHisto* _cih;
454 public:
455 HistoClosure(KlassInfoHisto* cih) : _cih(cih) {}
456
457 void do_cinfo(KlassInfoEntry* cie) {
458 _cih->add(cie);
459 }
460 };
461
462 class RecordInstanceClosure : public ObjectClosure {
463 private:
464 KlassInfoTable* _cit;
465 size_t _missed_count;
466 BoolObjectClosure* _filter;
467 public:
468 RecordInstanceClosure(KlassInfoTable* cit, BoolObjectClosure* filter) :
469 _cit(cit), _missed_count(0), _filter(filter) {}
470
471 void do_object(oop obj) {
472 if (should_visit(obj)) {
473 if (!_cit->record_instance(obj)) {
474 _missed_count++;
475 }
476 }
477 }
478
479 size_t missed_count() { return _missed_count; }
480
481 private:
482 bool should_visit(oop obj) {
483 return _filter == NULL || _filter->do_object_b(obj);
484 }
485 };
486
487 size_t HeapInspection::populate_table(KlassInfoTable* cit, BoolObjectClosure *filter) {
488 ResourceMark rm;
489
490 RecordInstanceClosure ric(cit, filter);
491 Universe::heap()->object_iterate(&ric);
492 return ric.missed_count();
493 }
494
495 void HeapInspection::heap_inspection(outputStream* st) {
496 ResourceMark rm;
497
498 if (_print_help) {
499 for (int c=0; c<KlassSizeStats::_num_columns; c++) {
500 st->print("%s:\n\t", name_table[c]);
501 const int max_col = 60;
502 int col = 0;
503 for (const char *p = help_table[c]; *p; p++,col++) {
504 if (col >= max_col && *p == ' ') {
505 st->print("\n\t");
506 col = 0;
507 } else {
508 st->print("%c", *p);
509 }
510 }
511 st->print_cr(".\n");
512 }
513 return;
514 }
515
516 KlassInfoTable cit(_print_class_stats);
517 if (!cit.allocation_failed()) {
518 size_t missed_count = populate_table(&cit);
519 if (missed_count != 0) {
520 st->print_cr("WARNING: Ran out of C-heap; undercounted " SIZE_FORMAT
521 " total instances in data below",
522 missed_count);
523 }
524
525 // Sort and print klass instance info
526 const char *title = "\n"
527 " num #instances #bytes class name\n"
528 "----------------------------------------------";
529 KlassInfoHisto histo(&cit, title);
530 HistoClosure hc(&histo);
531
532 cit.iterate(&hc);
533
534 histo.sort();
535 histo.print_histo_on(st, _print_class_stats, _csv_format, _columns);
536 } else {
537 st->print_cr("WARNING: Ran out of C-heap; histogram not generated");
538 }
539 st->flush();
540 }
541
542 class FindInstanceClosure : public ObjectClosure {
543 private:
544 Klass* _klass;
545 GrowableArray<oop>* _result;
546
547 public:
548 FindInstanceClosure(Klass* k, GrowableArray<oop>* result) : _klass(k), _result(result) {};
549
550 void do_object(oop obj) {
551 if (obj->is_a(_klass)) {
552 _result->append(obj);
553 }
554 }
555 };
556
557 void HeapInspection::find_instances_at_safepoint(Klass* k, GrowableArray<oop>* result) {
558 assert(SafepointSynchronize::is_at_safepoint(), "all threads are stopped");
559 assert(Heap_lock->is_locked(), "should have the Heap_lock");
560
561 // Ensure that the heap is parsable
562 Universe::heap()->ensure_parsability(false); // no need to retire TALBs
563
564 // Iterate over objects in the heap
565 FindInstanceClosure fic(k, result);
566 // If this operation encounters a bad object when using CMS,
567 // consider using safe_object_iterate() which avoids metadata
568 // objects that may contain bad references.
569 Universe::heap()->object_iterate(&fic);
570 }