1 /*
   2  * Copyright (c) 2002, 2018, 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.inline.hpp"
  27 #include "classfile/classLoaderDataGraph.hpp"
  28 #include "classfile/moduleEntry.hpp"
  29 #include "classfile/systemDictionary.hpp"
  30 #include "gc/shared/collectedHeap.hpp"
  31 #include "memory/heapInspection.hpp"
  32 #include "memory/resourceArea.hpp"
  33 #include "oops/oop.inline.hpp"
  34 #include "oops/reflectionAccessorImplKlassHelper.hpp"
  35 #include "runtime/os.hpp"
  36 #include "utilities/globalDefinitions.hpp"
  37 #include "utilities/macros.hpp"
  38 #include "utilities/stack.inline.hpp"
  39 
  40 // HeapInspection
  41 
  42 int KlassSizeStats::count(oop x) {
  43   return (HeapWordSize * (((x) != NULL) ? (x)->size() : 0));
  44 }
  45 
  46 int KlassSizeStats::count_array(objArrayOop x) {
  47   return (HeapWordSize * (((x) != NULL) ? (x)->size() : 0));
  48 }
  49 
  50 inline KlassInfoEntry::~KlassInfoEntry() {
  51   if (_subclasses != NULL) {
  52     delete _subclasses;
  53   }
  54 }
  55 
  56 inline void KlassInfoEntry::add_subclass(KlassInfoEntry* cie) {
  57   if (_subclasses == NULL) {
  58     _subclasses = new  (ResourceObj::C_HEAP, mtInternal) GrowableArray<KlassInfoEntry*>(4, true);
  59   }
  60   _subclasses->append(cie);
  61 }
  62 
  63 int KlassInfoEntry::compare(KlassInfoEntry* e1, KlassInfoEntry* e2) {
  64   if(e1->_instance_words > e2->_instance_words) {
  65     return -1;
  66   } else if(e1->_instance_words < e2->_instance_words) {
  67     return 1;
  68   }
  69   // Sort alphabetically, note 'Z' < '[' < 'a', but it's better to group
  70   // the array classes before all the instance classes.
  71   ResourceMark rm;
  72   const char* name1 = e1->klass()->external_name();
  73   const char* name2 = e2->klass()->external_name();
  74   bool d1 = (name1[0] == '[');
  75   bool d2 = (name2[0] == '[');
  76   if (d1 && !d2) {
  77     return -1;
  78   } else if (d2 && !d1) {
  79     return 1;
  80   } else {
  81     return strcmp(name1, name2);
  82   }
  83 }
  84 
  85 const char* KlassInfoEntry::name() const {
  86   const char* name;
  87   if (_klass->name() != NULL) {
  88     name = _klass->external_name();
  89   } else {
  90     if (_klass == Universe::boolArrayKlassObj())         name = "<boolArrayKlass>";         else
  91     if (_klass == Universe::charArrayKlassObj())         name = "<charArrayKlass>";         else
  92     if (_klass == Universe::floatArrayKlassObj())        name = "<floatArrayKlass>";        else
  93     if (_klass == Universe::doubleArrayKlassObj())       name = "<doubleArrayKlass>";       else
  94     if (_klass == Universe::byteArrayKlassObj())         name = "<byteArrayKlass>";         else
  95     if (_klass == Universe::shortArrayKlassObj())        name = "<shortArrayKlass>";        else
  96     if (_klass == Universe::intArrayKlassObj())          name = "<intArrayKlass>";          else
  97     if (_klass == Universe::longArrayKlassObj())         name = "<longArrayKlass>";         else
  98       name = "<no name>";
  99   }
 100   return name;
 101 }
 102 
 103 void KlassInfoEntry::print_on(outputStream* st) const {
 104   ResourceMark rm;
 105 
 106   // simplify the formatting (ILP32 vs LP64) - always cast the numbers to 64-bit
 107   ModuleEntry* module = _klass->module();
 108   if (module->is_named()) {
 109     st->print_cr(INT64_FORMAT_W(13) "  " UINT64_FORMAT_W(13) "  %s (%s@%s)",
 110                  (int64_t)_instance_count,
 111                  (uint64_t)_instance_words * HeapWordSize,
 112                  name(),
 113                  module->name()->as_C_string(),
 114                  module->version() != NULL ? module->version()->as_C_string() : "");
 115   } else {
 116     st->print_cr(INT64_FORMAT_W(13) "  " UINT64_FORMAT_W(13) "  %s",
 117                  (int64_t)_instance_count,
 118                  (uint64_t)_instance_words * HeapWordSize,
 119                  name());
 120   }
 121 }
 122 
 123 KlassInfoEntry* KlassInfoBucket::lookup(Klass* const k) {
 124   KlassInfoEntry* elt = _list;
 125   while (elt != NULL) {
 126     if (elt->is_equal(k)) {
 127       return elt;
 128     }
 129     elt = elt->next();
 130   }
 131   elt = new (std::nothrow) KlassInfoEntry(k, list());
 132   // We may be out of space to allocate the new entry.
 133   if (elt != NULL) {
 134     set_list(elt);
 135   }
 136   return elt;
 137 }
 138 
 139 void KlassInfoBucket::iterate(KlassInfoClosure* cic) {
 140   KlassInfoEntry* elt = _list;
 141   while (elt != NULL) {
 142     cic->do_cinfo(elt);
 143     elt = elt->next();
 144   }
 145 }
 146 
 147 void KlassInfoBucket::empty() {
 148   KlassInfoEntry* elt = _list;
 149   _list = NULL;
 150   while (elt != NULL) {
 151     KlassInfoEntry* next = elt->next();
 152     delete elt;
 153     elt = next;
 154   }
 155 }
 156 
 157 class KlassInfoTable::AllClassesFinder : public LockedClassesDo {
 158   KlassInfoTable *_table;
 159 public:
 160   AllClassesFinder(KlassInfoTable* table) : _table(table) {}
 161   virtual void do_klass(Klass* k) {
 162     // This has the SIDE EFFECT of creating a KlassInfoEntry
 163     // for <k>, if one doesn't exist yet.
 164     _table->lookup(k);
 165   }
 166 };
 167 
 168 
 169 KlassInfoTable::KlassInfoTable(bool add_all_classes) {
 170   _size_of_instances_in_words = 0;
 171   _size = 0;
 172   _ref = (HeapWord*) Universe::boolArrayKlassObj();
 173   _buckets =
 174     (KlassInfoBucket*)  AllocateHeap(sizeof(KlassInfoBucket) * _num_buckets,
 175        mtInternal, CURRENT_PC, AllocFailStrategy::RETURN_NULL);
 176   if (_buckets != NULL) {
 177     _size = _num_buckets;
 178     for (int index = 0; index < _size; index++) {
 179       _buckets[index].initialize();
 180     }
 181     if (add_all_classes) {
 182       AllClassesFinder finder(this);
 183       ClassLoaderDataGraph::classes_do(&finder);
 184     }
 185   }
 186 }
 187 
 188 KlassInfoTable::~KlassInfoTable() {
 189   if (_buckets != NULL) {
 190     for (int index = 0; index < _size; index++) {
 191       _buckets[index].empty();
 192     }
 193     FREE_C_HEAP_ARRAY(KlassInfoBucket, _buckets);
 194     _size = 0;
 195   }
 196 }
 197 
 198 uint KlassInfoTable::hash(const Klass* p) {
 199   return (uint)(((uintptr_t)p - (uintptr_t)_ref) >> 2);
 200 }
 201 
 202 KlassInfoEntry* KlassInfoTable::lookup(Klass* k) {
 203   uint         idx = hash(k) % _size;
 204   assert(_buckets != NULL, "Allocation failure should have been caught");
 205   KlassInfoEntry*  e   = _buckets[idx].lookup(k);
 206   // Lookup may fail if this is a new klass for which we
 207   // could not allocate space for an new entry.
 208   assert(e == NULL || k == e->klass(), "must be equal");
 209   return e;
 210 }
 211 
 212 // Return false if the entry could not be recorded on account
 213 // of running out of space required to create a new entry.
 214 bool KlassInfoTable::record_instance(const oop obj) {
 215   Klass*        k = obj->klass();
 216   KlassInfoEntry* elt = lookup(k);
 217   // elt may be NULL if it's a new klass for which we
 218   // could not allocate space for a new entry in the hashtable.
 219   if (elt != NULL) {
 220     elt->set_count(elt->count() + 1);
 221     elt->set_words(elt->words() + obj->size());
 222     _size_of_instances_in_words += obj->size();
 223     return true;
 224   } else {
 225     return false;
 226   }
 227 }
 228 
 229 void KlassInfoTable::iterate(KlassInfoClosure* cic) {
 230   assert(_size == 0 || _buckets != NULL, "Allocation failure should have been caught");
 231   for (int index = 0; index < _size; index++) {
 232     _buckets[index].iterate(cic);
 233   }
 234 }
 235 
 236 size_t KlassInfoTable::size_of_instances_in_words() const {
 237   return _size_of_instances_in_words;
 238 }
 239 
 240 int KlassInfoHisto::sort_helper(KlassInfoEntry** e1, KlassInfoEntry** e2) {
 241   return (*e1)->compare(*e1,*e2);
 242 }
 243 
 244 KlassInfoHisto::KlassInfoHisto(KlassInfoTable* cit) :
 245   _cit(cit) {
 246   _elements = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<KlassInfoEntry*>(_histo_initial_size, true);
 247 }
 248 
 249 KlassInfoHisto::~KlassInfoHisto() {
 250   delete _elements;
 251 }
 252 
 253 void KlassInfoHisto::add(KlassInfoEntry* cie) {
 254   elements()->append(cie);
 255 }
 256 
 257 void KlassInfoHisto::sort() {
 258   elements()->sort(KlassInfoHisto::sort_helper);
 259 }
 260 
 261 void KlassInfoHisto::print_elements(outputStream* st) const {
 262   // simplify the formatting (ILP32 vs LP64) - store the sum in 64-bit
 263   int64_t total = 0;
 264   uint64_t totalw = 0;
 265   for(int i=0; i < elements()->length(); i++) {
 266     st->print("%4d: ", i+1);
 267     elements()->at(i)->print_on(st);
 268     total += elements()->at(i)->count();
 269     totalw += elements()->at(i)->words();
 270   }
 271   st->print_cr("Total " INT64_FORMAT_W(13) "  " UINT64_FORMAT_W(13),
 272                total, totalw * HeapWordSize);
 273 }
 274 
 275 #define MAKE_COL_NAME(field, name, help)     #name,
 276 #define MAKE_COL_HELP(field, name, help)     help,
 277 
 278 static const char *name_table[] = {
 279   HEAP_INSPECTION_COLUMNS_DO(MAKE_COL_NAME)
 280 };
 281 
 282 static const char *help_table[] = {
 283   HEAP_INSPECTION_COLUMNS_DO(MAKE_COL_HELP)
 284 };
 285 
 286 bool KlassInfoHisto::is_selected(const char *col_name) {
 287   if (_selected_columns == NULL) {
 288     return true;
 289   }
 290   if (strcmp(_selected_columns, col_name) == 0) {
 291     return true;
 292   }
 293 
 294   const char *start = strstr(_selected_columns, col_name);
 295   if (start == NULL) {
 296     return false;
 297   }
 298 
 299   // The following must be true, because _selected_columns != col_name
 300   if (start > _selected_columns && start[-1] != ',') {
 301     return false;
 302   }
 303   char x = start[strlen(col_name)];
 304   if (x != ',' && x != '\0') {
 305     return false;
 306   }
 307 
 308   return true;
 309 }
 310 
 311 void KlassInfoHisto::print_title(outputStream* st, bool csv_format,
 312                                  bool selected[], int width_table[],
 313                                  const char *name_table[]) {
 314   if (csv_format) {
 315     st->print("Index,Super");
 316     for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 317        if (selected[c]) {st->print(",%s", name_table[c]);}
 318     }
 319     st->print(",ClassName");
 320   } else {
 321     st->print("Index Super");
 322     for (int c = 0; c < KlassSizeStats::_num_columns; c++) {
 323       if (selected[c]) {
 324         st->print("%*s", width_table[c], name_table[c]);
 325       }
 326     }
 327     st->print(" ClassName");
 328   }
 329 
 330   if (is_selected("ClassLoader")) {
 331     st->print(",ClassLoader");
 332   }
 333   st->cr();
 334 }
 335 
 336 class HierarchyClosure : public KlassInfoClosure {
 337 private:
 338   GrowableArray<KlassInfoEntry*> *_elements;
 339 public:
 340   HierarchyClosure(GrowableArray<KlassInfoEntry*> *_elements) : _elements(_elements) {}
 341 
 342   void do_cinfo(KlassInfoEntry* cie) {
 343     // ignore array classes
 344     if (cie->klass()->is_instance_klass()) {
 345       _elements->append(cie);
 346     }
 347   }
 348 };
 349 
 350 void KlassHierarchy::print_class_hierarchy(outputStream* st, bool print_interfaces,
 351                                            bool print_subclasses, char* classname) {
 352   ResourceMark rm;
 353   Stack <KlassInfoEntry*, mtClass> class_stack;
 354   GrowableArray<KlassInfoEntry*> elements;
 355 
 356   // Add all classes to the KlassInfoTable, which allows for quick lookup.
 357   // A KlassInfoEntry will be created for each class.
 358   KlassInfoTable cit(true);
 359   if (cit.allocation_failed()) {
 360     st->print_cr("ERROR: Ran out of C-heap; hierarchy not generated");
 361     return;
 362   }
 363 
 364   // Add all created KlassInfoEntry instances to the elements array for easy
 365   // iteration, and to allow each KlassInfoEntry instance to have a unique index.
 366   HierarchyClosure hc(&elements);
 367   cit.iterate(&hc);
 368 
 369   for(int i = 0; i < elements.length(); i++) {
 370     KlassInfoEntry* cie = elements.at(i);
 371     Klass* super = cie->klass()->super();
 372 
 373     // Set the index for the class.
 374     cie->set_index(i + 1);
 375 
 376     // Add the class to the subclass array of its superclass.
 377     if (super != NULL) {
 378       KlassInfoEntry* super_cie = cit.lookup(super);
 379       assert(super_cie != NULL, "could not lookup superclass");
 380       super_cie->add_subclass(cie);
 381     }
 382   }
 383 
 384   // Set the do_print flag for each class that should be printed.
 385   for(int i = 0; i < elements.length(); i++) {
 386     KlassInfoEntry* cie = elements.at(i);
 387     if (classname == NULL) {
 388       // We are printing all classes.
 389       cie->set_do_print(true);
 390     } else {
 391       // We are only printing the hierarchy of a specific class.
 392       if (strcmp(classname, cie->klass()->external_name()) == 0) {
 393         KlassHierarchy::set_do_print_for_class_hierarchy(cie, &cit, print_subclasses);
 394       }
 395     }
 396   }
 397 
 398   // Now we do a depth first traversal of the class hierachry. The class_stack will
 399   // maintain the list of classes we still need to process. Start things off
 400   // by priming it with java.lang.Object.
 401   KlassInfoEntry* jlo_cie = cit.lookup(SystemDictionary::Object_klass());
 402   assert(jlo_cie != NULL, "could not lookup java.lang.Object");
 403   class_stack.push(jlo_cie);
 404 
 405   // Repeatedly pop the top item off the stack, print its class info,
 406   // and push all of its subclasses on to the stack. Do this until there
 407   // are no classes left on the stack.
 408   while (!class_stack.is_empty()) {
 409     KlassInfoEntry* curr_cie = class_stack.pop();
 410     if (curr_cie->do_print()) {
 411       print_class(st, curr_cie, print_interfaces);
 412       if (curr_cie->subclasses() != NULL) {
 413         // Current class has subclasses, so push all of them onto the stack.
 414         for (int i = 0; i < curr_cie->subclasses()->length(); i++) {
 415           KlassInfoEntry* cie = curr_cie->subclasses()->at(i);
 416           if (cie->do_print()) {
 417             class_stack.push(cie);
 418           }
 419         }
 420       }
 421     }
 422   }
 423 
 424   st->flush();
 425 }
 426 
 427 // Sets the do_print flag for every superclass and subclass of the specified class.
 428 void KlassHierarchy::set_do_print_for_class_hierarchy(KlassInfoEntry* cie, KlassInfoTable* cit,
 429                                                       bool print_subclasses) {
 430   // Set do_print for all superclasses of this class.
 431   Klass* super = ((InstanceKlass*)cie->klass())->java_super();
 432   while (super != NULL) {
 433     KlassInfoEntry* super_cie = cit->lookup(super);
 434     super_cie->set_do_print(true);
 435     super = super->super();
 436   }
 437 
 438   // Set do_print for this class and all of its subclasses.
 439   Stack <KlassInfoEntry*, mtClass> class_stack;
 440   class_stack.push(cie);
 441   while (!class_stack.is_empty()) {
 442     KlassInfoEntry* curr_cie = class_stack.pop();
 443     curr_cie->set_do_print(true);
 444     if (print_subclasses && curr_cie->subclasses() != NULL) {
 445       // Current class has subclasses, so push all of them onto the stack.
 446       for (int i = 0; i < curr_cie->subclasses()->length(); i++) {
 447         KlassInfoEntry* cie = curr_cie->subclasses()->at(i);
 448         class_stack.push(cie);
 449       }
 450     }
 451   }
 452 }
 453 
 454 static void print_indent(outputStream* st, int indent) {
 455   while (indent != 0) {
 456     st->print("|");
 457     indent--;
 458     if (indent != 0) {
 459       st->print("  ");
 460     }
 461   }
 462 }
 463 
 464 // Print the class name and its unique ClassLoader identifer.
 465 static void print_classname(outputStream* st, Klass* klass) {
 466   oop loader_oop = klass->class_loader_data()->class_loader();
 467   st->print("%s/", klass->external_name());
 468   if (loader_oop == NULL) {
 469     st->print("null");
 470   } else {
 471     st->print(INTPTR_FORMAT, p2i(klass->class_loader_data()));
 472   }
 473 }
 474 
 475 static void print_interface(outputStream* st, InstanceKlass* intf_klass, const char* intf_type, int indent) {
 476   print_indent(st, indent);
 477   st->print("  implements ");
 478   print_classname(st, intf_klass);
 479   st->print(" (%s intf)\n", intf_type);
 480 }
 481 
 482 void KlassHierarchy::print_class(outputStream* st, KlassInfoEntry* cie, bool print_interfaces) {
 483   ResourceMark rm;
 484   InstanceKlass* klass = (InstanceKlass*)cie->klass();
 485   int indent = 0;
 486 
 487   // Print indentation with proper indicators of superclass.
 488   Klass* super = klass->super();
 489   while (super != NULL) {
 490     super = super->super();
 491     indent++;
 492   }
 493   print_indent(st, indent);
 494   if (indent != 0) st->print("--");
 495 
 496   // Print the class name, its unique ClassLoader identifer, and if it is an interface.
 497   print_classname(st, klass);
 498   if (klass->is_interface()) {
 499     st->print(" (intf)");
 500   }
 501   // Special treatment for generated core reflection accessor classes: print invocation target.
 502   if (ReflectionAccessorImplKlassHelper::is_generated_accessor(klass)) {
 503     st->print(" (invokes: ");
 504     ReflectionAccessorImplKlassHelper::print_invocation_target(st, klass);
 505     st->print(")");
 506   }
 507   st->print("\n");
 508 
 509   // Print any interfaces the class has.
 510   if (print_interfaces) {
 511     Array<InstanceKlass*>* local_intfs = klass->local_interfaces();
 512     Array<InstanceKlass*>* trans_intfs = klass->transitive_interfaces();
 513     for (int i = 0; i < local_intfs->length(); i++) {
 514       print_interface(st, local_intfs->at(i), "declared", indent);
 515     }
 516     for (int i = 0; i < trans_intfs->length(); i++) {
 517       InstanceKlass* trans_interface = trans_intfs->at(i);
 518       // Only print transitive interfaces if they are not also declared.
 519       if (!local_intfs->contains(trans_interface)) {
 520         print_interface(st, trans_interface, "inherited", indent);
 521       }
 522     }
 523   }
 524 }
 525 
 526 void KlassInfoHisto::print_class_stats(outputStream* st,
 527                                       bool csv_format, const char *columns) {
 528   ResourceMark rm;
 529   KlassSizeStats sz, sz_sum;
 530   int i;
 531   julong *col_table = (julong*)(&sz);
 532   julong *colsum_table = (julong*)(&sz_sum);
 533   int width_table[KlassSizeStats::_num_columns];
 534   bool selected[KlassSizeStats::_num_columns];
 535 
 536   _selected_columns = columns;
 537 
 538   memset(&sz_sum, 0, sizeof(sz_sum));
 539   for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 540     selected[c] = is_selected(name_table[c]);
 541   }
 542 
 543   for(i=0; i < elements()->length(); i++) {
 544     elements()->at(i)->set_index(i+1);
 545   }
 546 
 547   // First iteration is for accumulating stats totals in colsum_table[].
 548   // Second iteration is for printing stats for each class.
 549   for (int pass=1; pass<=2; pass++) {
 550     if (pass == 2) {
 551       print_title(st, csv_format, selected, width_table, name_table);
 552     }
 553     for(i=0; i < elements()->length(); i++) {
 554       KlassInfoEntry* e = (KlassInfoEntry*)elements()->at(i);
 555       const Klass* k = e->klass();
 556 
 557       // Get the stats for this class.
 558       memset(&sz, 0, sizeof(sz));
 559       sz._inst_count = e->count();
 560       sz._inst_bytes = HeapWordSize * e->words();
 561       k->collect_statistics(&sz);
 562       sz._total_bytes = sz._ro_bytes + sz._rw_bytes;
 563 
 564       if (pass == 1) {
 565         // Add the stats for this class to the overall totals.
 566         for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 567           colsum_table[c] += col_table[c];
 568         }
 569       } else {
 570         int super_index = -1;
 571         // Print the stats for this class.
 572         if (k->is_instance_klass()) {
 573           Klass* super = k->super();
 574           if (super) {
 575             KlassInfoEntry* super_e = _cit->lookup(super);
 576             if (super_e) {
 577               super_index = super_e->index();
 578             }
 579           }
 580         }
 581 
 582         if (csv_format) {
 583           st->print("%ld,%d", e->index(), super_index);
 584           for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 585             if (selected[c]) {st->print("," JULONG_FORMAT, col_table[c]);}
 586           }
 587           st->print(",%s",e->name());
 588         } else {
 589           st->print("%5ld %5d", e->index(), super_index);
 590           for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 591             if (selected[c]) {print_julong(st, width_table[c], col_table[c]);}
 592           }
 593           st->print(" %s", e->name());
 594         }
 595         if (is_selected("ClassLoader")) {
 596           ClassLoaderData* loader_data = k->class_loader_data();
 597           st->print(",");
 598           loader_data->print_value_on(st);
 599         }
 600         st->cr();
 601       }
 602     }
 603 
 604     if (pass == 1) {
 605       // Calculate the minimum width needed for the column by accounting for the
 606       // column header width and the width of the largest value in the column.
 607       for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 608         width_table[c] = col_width(colsum_table[c], name_table[c]);
 609       }
 610     }
 611   }
 612 
 613   sz_sum._inst_size = 0;
 614 
 615   // Print the column totals.
 616   if (csv_format) {
 617     st->print(",");
 618     for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 619       if (selected[c]) {st->print("," JULONG_FORMAT, colsum_table[c]);}
 620     }
 621   } else {
 622     st->print("           ");
 623     for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 624       if (selected[c]) {print_julong(st, width_table[c], colsum_table[c]);}
 625     }
 626     st->print(" Total");
 627     if (sz_sum._total_bytes > 0) {
 628       st->cr();
 629       st->print("           ");
 630       for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 631         if (selected[c]) {
 632           switch (c) {
 633           case KlassSizeStats::_index_inst_size:
 634           case KlassSizeStats::_index_inst_count:
 635           case KlassSizeStats::_index_method_count:
 636             st->print("%*s", width_table[c], "-");
 637             break;
 638           default:
 639             {
 640               double perc = (double)(100) * (double)(colsum_table[c]) / (double)sz_sum._total_bytes;
 641               st->print("%*.1f%%", width_table[c]-1, perc);
 642             }
 643           }
 644         }
 645       }
 646     }
 647   }
 648   st->cr();
 649 
 650   if (!csv_format) {
 651     print_title(st, csv_format, selected, width_table, name_table);
 652   }
 653 }
 654 
 655 julong KlassInfoHisto::annotations_bytes(Array<AnnotationArray*>* p) const {
 656   julong bytes = 0;
 657   if (p != NULL) {
 658     for (int i = 0; i < p->length(); i++) {
 659       bytes += count_bytes_array(p->at(i));
 660     }
 661     bytes += count_bytes_array(p);
 662   }
 663   return bytes;
 664 }
 665 
 666 void KlassInfoHisto::print_histo_on(outputStream* st, bool print_stats,
 667                                     bool csv_format, const char *columns) {
 668   if (print_stats) {
 669     print_class_stats(st, csv_format, columns);
 670   } else {
 671     st->print_cr(" num     #instances         #bytes  class name (module)");
 672     st->print_cr("-------------------------------------------------------");
 673     print_elements(st);
 674   }
 675 }
 676 
 677 class HistoClosure : public KlassInfoClosure {
 678  private:
 679   KlassInfoHisto* _cih;
 680  public:
 681   HistoClosure(KlassInfoHisto* cih) : _cih(cih) {}
 682 
 683   void do_cinfo(KlassInfoEntry* cie) {
 684     _cih->add(cie);
 685   }
 686 };
 687 
 688 class RecordInstanceClosure : public ObjectClosure {
 689  private:
 690   KlassInfoTable* _cit;
 691   size_t _missed_count;
 692   BoolObjectClosure* _filter;
 693  public:
 694   RecordInstanceClosure(KlassInfoTable* cit, BoolObjectClosure* filter) :
 695     _cit(cit), _missed_count(0), _filter(filter) {}
 696 
 697   void do_object(oop obj) {
 698     if (should_visit(obj)) {
 699       if (!_cit->record_instance(obj)) {
 700         _missed_count++;
 701       }
 702     }
 703   }
 704 
 705   size_t missed_count() { return _missed_count; }
 706 
 707  private:
 708   bool should_visit(oop obj) {
 709     return _filter == NULL || _filter->do_object_b(obj);
 710   }
 711 };
 712 
 713 size_t HeapInspection::populate_table(KlassInfoTable* cit, BoolObjectClosure *filter) {
 714   ResourceMark rm;
 715 
 716   RecordInstanceClosure ric(cit, filter);
 717   Universe::heap()->object_iterate(&ric);
 718   return ric.missed_count();
 719 }
 720 
 721 void HeapInspection::heap_inspection(outputStream* st) {
 722   ResourceMark rm;
 723 
 724   if (_print_help) {
 725     for (int c=0; c<KlassSizeStats::_num_columns; c++) {
 726       st->print("%s:\n\t", name_table[c]);
 727       const int max_col = 60;
 728       int col = 0;
 729       for (const char *p = help_table[c]; *p; p++,col++) {
 730         if (col >= max_col && *p == ' ') {
 731           st->print("\n\t");
 732           col = 0;
 733         } else {
 734           st->print("%c", *p);
 735         }
 736       }
 737       st->print_cr(".\n");
 738     }
 739     return;
 740   }
 741 
 742   KlassInfoTable cit(_print_class_stats);
 743   if (!cit.allocation_failed()) {
 744     // populate table with object allocation info
 745     size_t missed_count = populate_table(&cit);
 746     if (missed_count != 0) {
 747       st->print_cr("WARNING: Ran out of C-heap; undercounted " SIZE_FORMAT
 748                    " total instances in data below",
 749                    missed_count);
 750     }
 751 
 752     // Sort and print klass instance info
 753     KlassInfoHisto histo(&cit);
 754     HistoClosure hc(&histo);
 755 
 756     cit.iterate(&hc);
 757 
 758     histo.sort();
 759     histo.print_histo_on(st, _print_class_stats, _csv_format, _columns);
 760   } else {
 761     st->print_cr("ERROR: Ran out of C-heap; histogram not generated");
 762   }
 763   st->flush();
 764 }
 765 
 766 class FindInstanceClosure : public ObjectClosure {
 767  private:
 768   Klass* _klass;
 769   GrowableArray<oop>* _result;
 770 
 771  public:
 772   FindInstanceClosure(Klass* k, GrowableArray<oop>* result) : _klass(k), _result(result) {};
 773 
 774   void do_object(oop obj) {
 775     if (obj->is_a(_klass)) {
 776       _result->append(obj);
 777     }
 778   }
 779 };
 780 
 781 void HeapInspection::find_instances_at_safepoint(Klass* k, GrowableArray<oop>* result) {
 782   assert(SafepointSynchronize::is_at_safepoint(), "all threads are stopped");
 783   assert(Heap_lock->is_locked(), "should have the Heap_lock");
 784 
 785   // Ensure that the heap is parsable
 786   Universe::heap()->ensure_parsability(false);  // no need to retire TALBs
 787 
 788   // Iterate over objects in the heap
 789   FindInstanceClosure fic(k, result);
 790   // If this operation encounters a bad object when using CMS,
 791   // consider using safe_object_iterate() which avoids metadata
 792   // objects that may contain bad references.
 793   Universe::heap()->object_iterate(&fic);
 794 }