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