1 /*
   2  * Copyright (c) 2003, 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 package sun.jvm.hotspot.tools;
  26 
  27 import java.util.*;
  28 import sun.jvm.hotspot.gc.g1.*;
  29 import sun.jvm.hotspot.gc.parallel.*;
  30 import sun.jvm.hotspot.gc.serial.*;
  31 import sun.jvm.hotspot.gc.shared.*;
  32 import sun.jvm.hotspot.debugger.JVMDebugger;
  33 import sun.jvm.hotspot.memory.*;
  34 import sun.jvm.hotspot.oops.*;
  35 import sun.jvm.hotspot.runtime.*;
  36 
  37 public class HeapSummary extends Tool {
  38 
  39    public HeapSummary() {
  40       super();
  41    }
  42 
  43    public HeapSummary(JVMDebugger d) {
  44       super(d);
  45    }
  46 
  47    public static void main(String[] args) {
  48       HeapSummary hs = new HeapSummary();
  49       hs.execute(args);
  50    }
  51 
  52    @Override
  53    public String getName() {
  54       return "heapSummary";
  55    }
  56 
  57    public void run() {
  58       CollectedHeap heap = VM.getVM().getUniverse().heap();
  59       VM.Flag[] flags = VM.getVM().getCommandLineFlags();
  60       Map flagMap = new HashMap();
  61       if (flags == null) {
  62          System.out.println("WARNING: command line flags are not available");
  63       } else {
  64          for (int f = 0; f < flags.length; f++) {
  65             flagMap.put(flags[f].getName(), flags[f]);
  66          }
  67       }
  68 
  69       System.out.println();
  70       printGCAlgorithm(flagMap);
  71       System.out.println();
  72       System.out.println("Heap Configuration:");
  73       printValue("MinHeapFreeRatio         = ", getFlagValue("MinHeapFreeRatio", flagMap));
  74       printValue("MaxHeapFreeRatio         = ", getFlagValue("MaxHeapFreeRatio", flagMap));
  75       printValMB("MaxHeapSize              = ", getFlagValue("MaxHeapSize", flagMap));
  76       printValMB("NewSize                  = ", getFlagValue("NewSize", flagMap));
  77       printValMB("MaxNewSize               = ", getFlagValue("MaxNewSize", flagMap));
  78       printValMB("OldSize                  = ", getFlagValue("OldSize", flagMap));
  79       printValue("NewRatio                 = ", getFlagValue("NewRatio", flagMap));
  80       printValue("SurvivorRatio            = ", getFlagValue("SurvivorRatio", flagMap));
  81       printValMB("MetaspaceSize            = ", getFlagValue("MetaspaceSize", flagMap));
  82       printValMB("CompressedClassSpaceSize = ", getFlagValue("CompressedClassSpaceSize", flagMap));
  83       printValMB("MaxMetaspaceSize         = ", getFlagValue("MaxMetaspaceSize", flagMap));
  84       printValMB("G1HeapRegionSize         = ", HeapRegion.grainBytes());
  85 
  86       System.out.println();
  87       System.out.println("Heap Usage:");
  88 
  89       if (heap instanceof GenCollectedHeap) {
  90          GenCollectedHeap genHeap = (GenCollectedHeap) heap;
  91          for (int n = 0; n < genHeap.nGens(); n++) {
  92             Generation gen = genHeap.getGen(n);
  93             if (gen instanceof DefNewGeneration) {
  94                System.out.println("New Generation (Eden + 1 Survivor Space):");
  95                printGen(gen);
  96 
  97                ContiguousSpace eden = ((DefNewGeneration)gen).eden();
  98                System.out.println("Eden Space:");
  99                printSpace(eden);
 100 
 101                ContiguousSpace from = ((DefNewGeneration)gen).from();
 102                System.out.println("From Space:");
 103                printSpace(from);
 104 
 105                ContiguousSpace to = ((DefNewGeneration)gen).to();
 106                System.out.println("To Space:");
 107                printSpace(to);
 108             } else {
 109                System.out.println(gen.name() + ":");
 110                printGen(gen);
 111             }
 112          }
 113       } else if (heap instanceof G1CollectedHeap) {
 114           printG1HeapSummary((G1CollectedHeap)heap);
 115       } else if (heap instanceof ParallelScavengeHeap) {
 116          ParallelScavengeHeap psh = (ParallelScavengeHeap) heap;
 117          PSYoungGen youngGen = psh.youngGen();
 118          printPSYoungGen(youngGen);
 119 
 120          PSOldGen oldGen = psh.oldGen();
 121          long oldFree = oldGen.capacity() - oldGen.used();
 122          System.out.println("PS Old Generation");
 123          printValMB("capacity = ", oldGen.capacity());
 124          printValMB("used     = ", oldGen.used());
 125          printValMB("free     = ", oldFree);
 126          System.out.println(alignment + (double)oldGen.used() * 100.0 / oldGen.capacity() + "% used");
 127       } else {
 128          throw new RuntimeException("unknown CollectedHeap type : " + heap.getClass());
 129       }
 130 
 131       System.out.println();
 132       printInternStringStatistics();
 133    }
 134 
 135    // Helper methods
 136 
 137    private void printGCAlgorithm(Map flagMap) {
 138        long l = getFlagValue("UseTLAB", flagMap);
 139        if (l == 1L) {
 140           System.out.println("using thread-local object allocation.");
 141        }
 142 
 143        l = getFlagValue("UseConcMarkSweepGC", flagMap);
 144        if (l == 1L) {
 145           System.out.println("Concurrent Mark-Sweep GC");
 146           return;
 147        }
 148 
 149        l = getFlagValue("UseParallelGC", flagMap);
 150        if (l == 1L) {
 151           System.out.print("Parallel GC ");
 152           l = getFlagValue("ParallelGCThreads", flagMap);
 153           System.out.println("with " + l + " thread(s)");
 154           return;
 155        }
 156 
 157        l = getFlagValue("UseG1GC", flagMap);
 158        if (l == 1L) {
 159            System.out.print("Garbage-First (G1) GC ");
 160            l = getFlagValue("ParallelGCThreads", flagMap);
 161            System.out.println("with " + l + " thread(s)");
 162            return;
 163        }
 164 
 165        System.out.println("Mark Sweep Compact GC");
 166    }
 167 
 168    private void printPSYoungGen(PSYoungGen youngGen) {
 169       System.out.println("PS Young Generation");
 170       MutableSpace eden = youngGen.edenSpace();
 171       System.out.println("Eden Space:");
 172       printMutableSpace(eden);
 173       MutableSpace from = youngGen.fromSpace();
 174       System.out.println("From Space:");
 175       printMutableSpace(from);
 176       MutableSpace to = youngGen.toSpace();
 177       System.out.println("To Space:");
 178       printMutableSpace(to);
 179    }
 180 
 181    private void printMutableSpace(MutableSpace space) {
 182       printValMB("capacity = ", space.capacity());
 183       printValMB("used     = ", space.used());
 184       long free = space.capacity() - space.used();
 185       printValMB("free     = ", free);
 186       System.out.println(alignment + (double)space.used() * 100.0 / space.capacity() + "% used");
 187    }
 188 
 189    private static String alignment = "   ";
 190 
 191    private void printGen(Generation gen) {
 192       printValMB("capacity = ", gen.capacity());
 193       printValMB("used     = ", gen.used());
 194       printValMB("free     = ", gen.free());
 195       System.out.println(alignment + (double)gen.used() * 100.0 / gen.capacity() + "% used");
 196    }
 197 
 198    private void printSpace(ContiguousSpace space) {
 199       printValMB("capacity = ", space.capacity());
 200       printValMB("used     = ", space.used());
 201       printValMB("free     = ", space.free());
 202       System.out.println(alignment +  (double)space.used() * 100.0 / space.capacity() + "% used");
 203    }
 204 
 205    public void printG1HeapSummary(G1CollectedHeap g1h) {
 206       G1MonitoringSupport g1mm = g1h.g1mm();
 207       long edenRegionNum = g1mm.edenRegionNum();
 208       long survivorRegionNum = g1mm.survivorRegionNum();
 209       HeapRegionSetBase oldSet = g1h.oldSet();
 210       HeapRegionSetBase humongousSet = g1h.humongousSet();
 211       long oldRegionNum = oldSet.length() + humongousSet.length();
 212       printG1Space("G1 Heap:", g1h.n_regions(),
 213                    g1h.used(), g1h.capacity());
 214       System.out.println("G1 Young Generation:");
 215       printG1Space("Eden Space:", edenRegionNum,
 216                    g1mm.edenUsed(), g1mm.edenCommitted());
 217       printG1Space("Survivor Space:", survivorRegionNum,
 218                    g1mm.survivorUsed(), g1mm.survivorCommitted());
 219       printG1Space("G1 Old Generation:", oldRegionNum,
 220                    g1mm.oldUsed(), g1mm.oldCommitted());
 221    }
 222 
 223    private void printG1Space(String spaceName, long regionNum,
 224                              long used, long capacity) {
 225       long free = capacity - used;
 226       System.out.println(spaceName);
 227       printValue("regions  = ", regionNum);
 228       printValMB("capacity = ", capacity);
 229       printValMB("used     = ", used);
 230       printValMB("free     = ", free);
 231       double occPerc = (capacity > 0) ? (double) used * 100.0 / capacity : 0.0;
 232       System.out.println(alignment + occPerc + "% used");
 233    }
 234 
 235    private static final double FACTOR = 1024*1024;
 236    private void printValMB(String title, long value) {
 237       if (value < 0) {
 238         System.out.println(alignment + title +   (value >>> 20)  + " MB");
 239       } else {
 240         double mb = value/FACTOR;
 241         System.out.println(alignment + title + value + " (" + mb + "MB)");
 242       }
 243    }
 244 
 245    private void printValue(String title, long value) {
 246       System.out.println(alignment + title + value);
 247    }
 248 
 249    private long getFlagValue(String name, Map flagMap) {
 250       VM.Flag f = (VM.Flag) flagMap.get(name);
 251       if (f != null) {
 252          if (f.isBool()) {
 253             return f.getBool()? 1L : 0L;
 254          } else {
 255             return Long.parseLong(f.getValue());
 256          }
 257       } else {
 258          return -1;
 259       }
 260    }
 261 
 262    private void printInternStringStatistics() {
 263       class StringStat implements StringTable.StringVisitor {
 264          private int count;
 265          private long size;
 266          private OopField stringValueField;
 267 
 268          StringStat() {
 269             VM vm = VM.getVM();
 270             SystemDictionary sysDict = vm.getSystemDictionary();
 271             InstanceKlass strKlass = sysDict.getStringKlass();
 272             // String has a field named 'value' of type 'byte[]'.
 273             stringValueField = (OopField) strKlass.findField("value", "[B");
 274          }
 275 
 276          private long stringSize(Instance instance) {
 277             // We include String content in size calculation.
 278             return instance.getObjectSize() +
 279                    stringValueField.getValue(instance).getObjectSize();
 280          }
 281 
 282          public void visit(Instance str) {
 283             count++;
 284             size += stringSize(str);
 285          }
 286 
 287          public void print() {
 288             System.out.println(count +
 289                   " interned Strings occupying " + size + " bytes.");
 290          }
 291       }
 292 
 293       StringStat stat = new StringStat();
 294       StringTable strTable = VM.getVM().getStringTable();
 295       strTable.stringsDo(stat);
 296       stat.print();
 297    }
 298 }