1 /*
   2  * Copyright (c) 2000, 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.memory;
  26 
  27 import java.io.PrintStream;
  28 import java.util.Observable;
  29 import java.util.Observer;
  30 
  31 import sun.jvm.hotspot.debugger.Address;
  32 import sun.jvm.hotspot.debugger.OopHandle;
  33 import sun.jvm.hotspot.gc.cms.CMSHeap;
  34 import sun.jvm.hotspot.gc.epsilon.EpsilonHeap;
  35 import sun.jvm.hotspot.gc.g1.G1CollectedHeap;
  36 import sun.jvm.hotspot.gc.parallel.ParallelScavengeHeap;
  37 import sun.jvm.hotspot.gc.serial.SerialHeap;
  38 import sun.jvm.hotspot.gc.shared.CollectedHeap;
  39 import sun.jvm.hotspot.gc.shenandoah.ShenandoahHeap;
  40 import sun.jvm.hotspot.gc.z.ZCollectedHeap;
  41 import sun.jvm.hotspot.oops.Oop;
  42 import sun.jvm.hotspot.runtime.BasicType;
  43 import sun.jvm.hotspot.runtime.VM;
  44 import sun.jvm.hotspot.runtime.VirtualConstructor;
  45 import sun.jvm.hotspot.types.AddressField;
  46 import sun.jvm.hotspot.types.CIntegerField;
  47 import sun.jvm.hotspot.types.Type;
  48 import sun.jvm.hotspot.types.TypeDataBase;
  49 
  50 
  51 public class Universe {
  52   private static AddressField collectedHeapField;
  53   private static VirtualConstructor heapConstructor;
  54   private static sun.jvm.hotspot.types.OopField mainThreadGroupField;
  55   private static sun.jvm.hotspot.types.OopField systemThreadGroupField;
  56 
  57   // single dimensional primitive array klasses
  58   private static sun.jvm.hotspot.types.AddressField boolArrayKlassField;
  59   private static sun.jvm.hotspot.types.AddressField byteArrayKlassField;
  60   private static sun.jvm.hotspot.types.AddressField charArrayKlassField;
  61   private static sun.jvm.hotspot.types.AddressField intArrayKlassField;
  62   private static sun.jvm.hotspot.types.AddressField shortArrayKlassField;
  63   private static sun.jvm.hotspot.types.AddressField longArrayKlassField;
  64   private static sun.jvm.hotspot.types.AddressField singleArrayKlassField;
  65   private static sun.jvm.hotspot.types.AddressField doubleArrayKlassField;
  66 
  67   private static AddressField narrowOopBaseField;
  68   private static CIntegerField narrowOopShiftField;
  69   private static AddressField narrowKlassBaseField;
  70   private static CIntegerField narrowKlassShiftField;
  71 
  72   public enum NARROW_OOP_MODE {
  73     UnscaledNarrowOop,
  74     ZeroBasedNarrowOop,
  75     HeapBasedNarrowOop
  76   }
  77 
  78   static {
  79     VM.registerVMInitializedObserver(new Observer() {
  80         public void update(Observable o, Object data) {
  81           initialize(VM.getVM().getTypeDataBase());
  82         }
  83       });
  84   }
  85 
  86   private static boolean typeExists(TypeDataBase db, String type) {
  87       try {
  88           db.lookupType(type);
  89       } catch (RuntimeException e) {
  90           return false;
  91       }
  92       return true;
  93   }
  94 
  95   private static void addHeapTypeIfInDB(TypeDataBase db, Class heapClass) {
  96       String heapName = heapClass.getSimpleName();
  97       if (typeExists(db, heapName)) {
  98           heapConstructor.addMapping(heapName, heapClass);
  99       }
 100   }
 101 
 102   private static synchronized void initialize(TypeDataBase db) {
 103     Type type = db.lookupType("Universe");
 104 
 105     collectedHeapField = type.getAddressField("_collectedHeap");
 106 
 107     heapConstructor = new VirtualConstructor(db);
 108     addHeapTypeIfInDB(db, CMSHeap.class);
 109     addHeapTypeIfInDB(db, SerialHeap.class);
 110     addHeapTypeIfInDB(db, ParallelScavengeHeap.class);
 111     addHeapTypeIfInDB(db, G1CollectedHeap.class);
 112     addHeapTypeIfInDB(db, EpsilonHeap.class);
 113     addHeapTypeIfInDB(db, ZCollectedHeap.class);
 114     addHeapTypeIfInDB(db, ShenandoahHeap.class);
 115 
 116     mainThreadGroupField   = type.getOopField("_main_thread_group");
 117     systemThreadGroupField = type.getOopField("_system_thread_group");
 118 
 119     boolArrayKlassField      = type.getAddressField("_boolArrayKlassObj");
 120     byteArrayKlassField      = type.getAddressField("_byteArrayKlassObj");
 121     charArrayKlassField      = type.getAddressField("_charArrayKlassObj");
 122     intArrayKlassField       = type.getAddressField("_intArrayKlassObj");
 123     shortArrayKlassField     = type.getAddressField("_shortArrayKlassObj");
 124     longArrayKlassField      = type.getAddressField("_longArrayKlassObj");
 125     singleArrayKlassField    = type.getAddressField("_singleArrayKlassObj");
 126     doubleArrayKlassField    = type.getAddressField("_doubleArrayKlassObj");
 127 
 128     narrowOopBaseField = type.getAddressField("_narrow_oop._base");
 129     narrowOopShiftField = type.getCIntegerField("_narrow_oop._shift");
 130     narrowKlassBaseField = type.getAddressField("_narrow_klass._base");
 131     narrowKlassShiftField = type.getCIntegerField("_narrow_klass._shift");
 132 
 133     UniverseExt.initialize(heapConstructor);
 134   }
 135 
 136   public Universe() {
 137   }
 138   public static String narrowOopModeToString(NARROW_OOP_MODE mode) {
 139     switch (mode) {
 140     case UnscaledNarrowOop:
 141       return "32-bits Oops";
 142     case ZeroBasedNarrowOop:
 143       return "zero based Compressed Oops";
 144     case HeapBasedNarrowOop:
 145       return "Compressed Oops with base";
 146     }
 147     return "";
 148   }
 149   public CollectedHeap heap() {
 150     return (CollectedHeap) heapConstructor.instantiateWrapperFor(collectedHeapField.getValue());
 151   }
 152 
 153   public static long getNarrowOopBase() {
 154     if (narrowOopBaseField.getValue() == null) {
 155       return 0;
 156     } else {
 157       return narrowOopBaseField.getValue().minus(null);
 158     }
 159   }
 160 
 161   public static int getNarrowOopShift() {
 162     return (int)narrowOopShiftField.getValue();
 163   }
 164 
 165   public static long getNarrowKlassBase() {
 166     if (narrowKlassBaseField.getValue() == null) {
 167       return 0;
 168     } else {
 169       return narrowKlassBaseField.getValue().minus(null);
 170     }
 171   }
 172 
 173   public static int getNarrowKlassShift() {
 174     return (int)narrowKlassShiftField.getValue();
 175   }
 176 
 177 
 178   /** Returns "TRUE" iff "p" points into the allocated area of the heap. */
 179   public boolean isIn(Address p) {
 180     return heap().isIn(p);
 181   }
 182 
 183   /** Returns "TRUE" iff "p" points into the reserved area of the heap. */
 184   public boolean isInReserved(Address p) {
 185     return heap().isInReserved(p);
 186   }
 187 
 188   private Oop newOop(OopHandle handle) {
 189     return VM.getVM().getObjectHeap().newOop(handle);
 190   }
 191 
 192   public Oop mainThreadGroup() {
 193     return newOop(mainThreadGroupField.getValue());
 194   }
 195 
 196   public Oop systemThreadGroup() {
 197     return newOop(systemThreadGroupField.getValue());
 198   }
 199 
 200 
 201   public void print() { printOn(System.out); }
 202   public void printOn(PrintStream tty) {
 203     heap().printOn(tty);
 204   }
 205 
 206   // Check whether an element of a typeArrayOop with the given type must be
 207   // aligned 0 mod 8.  The typeArrayOop itself must be aligned at least this
 208   // strongly.
 209   public static boolean elementTypeShouldBeAligned(BasicType type) {
 210     return type == BasicType.T_DOUBLE || type == BasicType.T_LONG;
 211   }
 212 
 213   // Check whether an object field (static/non-static) of the given type must be
 214   // aligned 0 mod 8.
 215   public static boolean fieldTypeShouldBeAligned(BasicType type) {
 216     return type == BasicType.T_DOUBLE || type == BasicType.T_LONG;
 217   }
 218 }