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