1 /*
   2  * Copyright (c) 2012, 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 package sun.hotspot;
  26 
  27 import java.lang.reflect.Executable;
  28 import java.util.Arrays;
  29 import java.util.List;
  30 import java.util.function.Function;
  31 import java.util.stream.Stream;
  32 import java.security.BasicPermission;
  33 
  34 import sun.hotspot.parser.DiagnosticCommand;
  35 
  36 public class WhiteBox {
  37 
  38   @SuppressWarnings("serial")
  39   public static class WhiteBoxPermission extends BasicPermission {
  40     public WhiteBoxPermission(String s) {
  41       super(s);
  42     }
  43   }
  44 
  45   private WhiteBox() {}
  46   private static final WhiteBox instance = new WhiteBox();
  47   private static native void registerNatives();
  48 
  49   /**
  50    * Returns the singleton WhiteBox instance.
  51    *
  52    * The returned WhiteBox object should be carefully guarded
  53    * by the caller, since it can be used to read and write data
  54    * at arbitrary memory addresses. It must never be passed to
  55    * untrusted code.
  56    */
  57   public synchronized static WhiteBox getWhiteBox() {
  58     SecurityManager sm = System.getSecurityManager();
  59     if (sm != null) {
  60       sm.checkPermission(new WhiteBoxPermission("getInstance"));
  61     }
  62     return instance;
  63   }
  64 
  65   static {
  66     registerNatives();
  67   }
  68 
  69   // Get the maximum heap size supporting COOPs
  70   public native long getCompressedOopsMaxHeapSize();
  71   // Arguments
  72   public native void printHeapSizes();
  73 
  74   // Memory
  75   public native long getObjectAddress(Object o);
  76   public native int  getHeapOopSize();
  77   public native boolean isObjectInOldGen(Object o);
  78   public native long getObjectSize(Object o);
  79 
  80   // Runtime
  81   // Make sure class name is in the correct format
  82   public boolean isClassAlive(String name) {
  83     return isClassAlive0(name.replace('.', '/'));
  84   }
  85   private native boolean isClassAlive0(String name);
  86 
  87   // G1
  88   public native boolean g1InConcurrentMark();
  89   public native boolean g1IsHumongous(Object o);
  90   public native long    g1NumFreeRegions();
  91   public native int     g1RegionSize();
  92   public native Object[]    parseCommandLine(String commandline, DiagnosticCommand[] args);
  93 
  94   // NMT
  95   public native long NMTMalloc(long size);
  96   public native void NMTFree(long mem);
  97   public native long NMTReserveMemory(long size);
  98   public native void NMTCommitMemory(long addr, long size);
  99   public native void NMTUncommitMemory(long addr, long size);
 100   public native void NMTReleaseMemory(long addr, long size);
 101   public native long NMTMallocWithPseudoStack(long size, int index);
 102   public native boolean NMTIsDetailSupported();
 103   public native boolean NMTChangeTrackingLevel();
 104   public native int NMTGetHashSize();
 105 
 106   // Compiler
 107   public native int     deoptimizeFrames(boolean makeNotEntrant);
 108   public native void    deoptimizeAll();
 109   public        boolean isMethodCompiled(Executable method) {
 110     return isMethodCompiled(method, false /*not osr*/);
 111   }
 112   public native boolean isMethodCompiled(Executable method, boolean isOsr);
 113   public        boolean isMethodCompilable(Executable method) {
 114     return isMethodCompilable(method, -1 /*any*/);
 115   }
 116   public        boolean isMethodCompilable(Executable method, int compLevel) {
 117     return isMethodCompilable(method, compLevel, false /*not osr*/);
 118   }
 119   public native boolean isMethodCompilable(Executable method, int compLevel, boolean isOsr);
 120   public native boolean isMethodQueuedForCompilation(Executable method);
 121   public        int     deoptimizeMethod(Executable method) {
 122     return deoptimizeMethod(method, false /*not osr*/);
 123   }
 124   public native int     deoptimizeMethod(Executable method, boolean isOsr);
 125   public        void    makeMethodNotCompilable(Executable method) {
 126     makeMethodNotCompilable(method, -1 /*any*/);
 127   }
 128   public        void    makeMethodNotCompilable(Executable method, int compLevel) {
 129     makeMethodNotCompilable(method, compLevel, false /*not osr*/);
 130   }
 131   public native void    makeMethodNotCompilable(Executable method, int compLevel, boolean isOsr);
 132   public        int     getMethodCompilationLevel(Executable method) {
 133     return getMethodCompilationLevel(method, false /*not ost*/);
 134   }
 135   public native int     getMethodCompilationLevel(Executable method, boolean isOsr);
 136   public native boolean testSetDontInlineMethod(Executable method, boolean value);
 137   public        int     getCompileQueuesSize() {
 138     return getCompileQueueSize(-1 /*any*/);
 139   }
 140   public native int     getCompileQueueSize(int compLevel);
 141   public native boolean testSetForceInlineMethod(Executable method, boolean value);
 142   public        boolean enqueueMethodForCompilation(Executable method, int compLevel) {
 143     return enqueueMethodForCompilation(method, compLevel, -1 /*InvocationEntryBci*/);
 144   }
 145   public native boolean enqueueMethodForCompilation(Executable method, int compLevel, int entry_bci);
 146   public native void    clearMethodState(Executable method);
 147   public native void    lockCompilation();
 148   public native void    unlockCompilation();
 149   public native int     getMethodEntryBci(Executable method);
 150   public native Object[] getNMethod(Executable method, boolean isOsr);
 151   public native long    allocateCodeBlob(int size, int type);
 152   public native void    freeCodeBlob(long addr);
 153   public native void    forceNMethodSweep();
 154   public native Object[] getCodeHeapEntries(int type);
 155   public native int     getCompilationActivityMode();
 156   public native Object[] getCodeBlob(long addr);
 157 
 158   // Intered strings
 159   public native boolean isInStringTable(String str);
 160 
 161   // Memory
 162   public native void readReservedMemory();
 163   public native long allocateMetaspace(ClassLoader classLoader, long size);
 164   public native void freeMetaspace(ClassLoader classLoader, long addr, long size);
 165   public native long incMetaspaceCapacityUntilGC(long increment);
 166   public native long metaspaceCapacityUntilGC();
 167 
 168   // force Young GC
 169   public native void youngGC();
 170 
 171   // force Full GC
 172   public native void fullGC();
 173 
 174   // Tests on ReservedSpace/VirtualSpace classes
 175   public native int stressVirtualSpaceResize(long reservedSpaceSize, long magnitude, long iterations);
 176   public native void runMemoryUnitTests();
 177   public native void readFromNoaccessArea();
 178   public native long getThreadStackSize();
 179   public native long getThreadRemainingStackSize();
 180 
 181   // CPU features
 182   public native String getCPUFeatures();
 183 
 184   // Native extensions
 185   public native long getHeapUsageForContext(int context);
 186   public native long getHeapRegionCountForContext(int context);
 187   public native int getContextForObject(Object obj);
 188   public native void printRegionInfo(int context);
 189 
 190   // VM flags
 191   public native boolean isConstantVMFlag(String name);
 192   public native boolean isLockedVMFlag(String name);
 193   public native void    setBooleanVMFlag(String name, boolean value);
 194   public native void    setIntxVMFlag(String name, long value);
 195   public native void    setUintxVMFlag(String name, long value);
 196   public native void    setUint64VMFlag(String name, long value);
 197   public native void    setSizeTVMFlag(String name, long value);
 198   public native void    setStringVMFlag(String name, String value);
 199   public native void    setDoubleVMFlag(String name, double value);
 200   public native Boolean getBooleanVMFlag(String name);
 201   public native Long    getIntxVMFlag(String name);
 202   public native Long    getUintxVMFlag(String name);
 203   public native Long    getUint64VMFlag(String name);
 204   public native Long    getSizeTVMFlag(String name);
 205   public native String  getStringVMFlag(String name);
 206   public native Double  getDoubleVMFlag(String name);
 207   private final List<Function<String,Object>> flagsGetters = Arrays.asList(
 208     this::getBooleanVMFlag, this::getIntxVMFlag, this::getUintxVMFlag,
 209     this::getUint64VMFlag, this::getSizeTVMFlag, this::getStringVMFlag,
 210     this::getDoubleVMFlag);
 211 
 212   public Object getVMFlag(String name) {
 213     return flagsGetters.stream()
 214                        .map(f -> f.apply(name))
 215                        .filter(x -> x != null)
 216                        .findAny()
 217                        .orElse(null);
 218   }
 219   public native int getOffsetForName0(String name);
 220   public int getOffsetForName(String name) throws Exception {
 221     int offset = getOffsetForName0(name);
 222     if (offset == -1) {
 223       throw new RuntimeException(name + " not found");
 224     }
 225     return offset;
 226   }
 227 
 228 }