WhiteBox.java revision 2767:c1d93422c78e
197403Sobrien/* 297403Sobrien * Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved. 3169691Skan * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4117397Skan * 597403Sobrien * This code is free software; you can redistribute it and/or modify it 697403Sobrien * under the terms of the GNU General Public License version 2 only, as 797403Sobrien * published by the Free Software Foundation. 897403Sobrien * 997403Sobrien * This code is distributed in the hope that it will be useful, but WITHOUT 1097403Sobrien * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1197403Sobrien * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1297403Sobrien * version 2 for more details (a copy is included in the LICENSE file that 1397403Sobrien * accompanied this code). 1497403Sobrien * 1597403Sobrien * You should have received a copy of the GNU General Public License version 1697403Sobrien * 2 along with this work; if not, write to the Free Software Foundation, 1797403Sobrien * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1897403Sobrien * 19169691Skan * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2097403Sobrien * or visit www.oracle.com if you need additional information or have any 2197403Sobrien * questions. 2297403Sobrien */ 2397403Sobrien 2497403Sobrienpackage sun.hotspot; 2597403Sobrien 2697403Sobrienimport java.lang.management.MemoryUsage; 2797403Sobrienimport java.lang.reflect.Executable; 2897403Sobrienimport java.util.Arrays; 2997403Sobrienimport java.util.List; 3097403Sobrienimport java.util.function.BiFunction; 31169691Skanimport java.util.function.Function; 32169691Skanimport java.security.BasicPermission; 33169691Skanimport java.util.Objects; 34169691Skan 3597403Sobrienimport sun.hotspot.parser.DiagnosticCommand; 3697403Sobrien 3797403Sobrienpublic class WhiteBox { 3897403Sobrien @SuppressWarnings("serial") 39132720Skan public static class WhiteBoxPermission extends BasicPermission { 40132720Skan public WhiteBoxPermission(String s) { 4197403Sobrien super(s); 4297403Sobrien } 4397403Sobrien } 4497403Sobrien 45117397Skan private WhiteBox() {} 46132720Skan private static final WhiteBox instance = new WhiteBox(); 47117397Skan private static native void registerNatives(); 48117397Skan 49132720Skan /** 5097403Sobrien * Returns the singleton WhiteBox instance. 5197403Sobrien * 52169691Skan * The returned WhiteBox object should be carefully guarded 53169691Skan * by the caller, since it can be used to read and write data 5497403Sobrien * at arbitrary memory addresses. It must never be passed to 5597403Sobrien * untrusted code. 5697403Sobrien */ 5797403Sobrien public synchronized static WhiteBox getWhiteBox() { 5897403Sobrien SecurityManager sm = System.getSecurityManager(); 5997403Sobrien if (sm != null) { 6097403Sobrien sm.checkPermission(new WhiteBoxPermission("getInstance")); 6197403Sobrien } 6297403Sobrien return instance; 6397403Sobrien } 6497403Sobrien 6597403Sobrien static { 6697403Sobrien registerNatives(); 6797403Sobrien } 6897403Sobrien 6997403Sobrien // Get the maximum heap size supporting COOPs 7097403Sobrien public native long getCompressedOopsMaxHeapSize(); 7197403Sobrien // Arguments 7297403Sobrien public native void printHeapSizes(); 7397403Sobrien 7497403Sobrien // Memory 7597403Sobrien private native long getObjectAddress0(Object o); 7697403Sobrien public long getObjectAddress(Object o) { 7797403Sobrien Objects.requireNonNull(o); 7897403Sobrien return getObjectAddress0(o); 7997403Sobrien } 8097403Sobrien 8197403Sobrien public native int getHeapOopSize(); 8297403Sobrien public native int getVMPageSize(); 8397403Sobrien public native long getVMAllocationGranularity(); 8497403Sobrien public native long getVMLargePageSize(); 8597403Sobrien public native long getHeapSpaceAlignment(); 8697403Sobrien public native long getHeapAlignment(); 8797403Sobrien 8897403Sobrien private native boolean isObjectInOldGen0(Object o); 8997403Sobrien public boolean isObjectInOldGen(Object o) { 9097403Sobrien Objects.requireNonNull(o); 9197403Sobrien return isObjectInOldGen0(o); 9297403Sobrien } 9397403Sobrien 9497403Sobrien private native long getObjectSize0(Object o); 9597403Sobrien public long getObjectSize(Object o) { 9697403Sobrien Objects.requireNonNull(o); 9797403Sobrien return getObjectSize0(o); 9897403Sobrien } 9997403Sobrien 10097403Sobrien // Runtime 10197403Sobrien // Make sure class name is in the correct format 10297403Sobrien public boolean isClassAlive(String name) { 103132720Skan return isClassAlive0(name.replace('.', '/')); 10497403Sobrien } 10597403Sobrien private native boolean isClassAlive0(String name); 10697403Sobrien 107117397Skan private native boolean isMonitorInflated0(Object obj); 108117397Skan public boolean isMonitorInflated(Object obj) { 109117397Skan Objects.requireNonNull(obj); 110117397Skan return isMonitorInflated0(obj); 111117397Skan } 112117397Skan 113117397Skan public native void forceSafepoint(); 114117397Skan 115117397Skan private native long getConstantPool0(Class<?> aClass); 116117397Skan public long getConstantPool(Class<?> aClass) { 117117397Skan Objects.requireNonNull(aClass); 118117397Skan return getConstantPool0(aClass); 119117397Skan } 120117397Skan 121117397Skan private native int getConstantPoolCacheIndexTag0(); 122117397Skan public int getConstantPoolCacheIndexTag() { 123117397Skan return getConstantPoolCacheIndexTag0(); 124117397Skan } 125117397Skan 126117397Skan private native int getConstantPoolCacheLength0(Class<?> aClass); 127117397Skan public int getConstantPoolCacheLength(Class<?> aClass) { 128117397Skan Objects.requireNonNull(aClass); 129117397Skan return getConstantPoolCacheLength0(aClass); 130117397Skan } 131117397Skan 132117397Skan private native int remapInstructionOperandFromCPCache0(Class<?> aClass, int index); 133117397Skan public int remapInstructionOperandFromCPCache(Class<?> aClass, int index) { 134117397Skan Objects.requireNonNull(aClass); 135117397Skan return remapInstructionOperandFromCPCache0(aClass, index); 136117397Skan } 137117397Skan 138117397Skan private native int encodeConstantPoolIndyIndex0(int index); 139117397Skan public int encodeConstantPoolIndyIndex(int index) { 140117397Skan return encodeConstantPoolIndyIndex0(index); 141117397Skan } 142117397Skan 143117397Skan // JVMTI 144117397Skan private native void addToBootstrapClassLoaderSearch0(String segment); 145117397Skan public void addToBootstrapClassLoaderSearch(String segment){ 146117397Skan Objects.requireNonNull(segment); 147117397Skan addToBootstrapClassLoaderSearch0(segment); 14897403Sobrien } 149132720Skan 150117397Skan private native void addToSystemClassLoaderSearch0(String segment); 151117397Skan public void addToSystemClassLoaderSearch(String segment) { 152117397Skan Objects.requireNonNull(segment); 153117397Skan addToSystemClassLoaderSearch0(segment); 154117397Skan } 155117397Skan 156117397Skan // G1 157117397Skan public native boolean g1InConcurrentMark(); 158117397Skan private native boolean g1IsHumongous0(Object o); 159117397Skan public boolean g1IsHumongous(Object o) { 160117397Skan Objects.requireNonNull(o); 161117397Skan return g1IsHumongous0(o); 162117397Skan } 163107606Sobrien 164117397Skan private native boolean g1BelongsToHumongousRegion0(long adr); 16597403Sobrien public boolean g1BelongsToHumongousRegion(long adr) { 166169691Skan if (adr == 0) { 167169691Skan throw new IllegalArgumentException("adr argument should not be null"); 168132720Skan } 169 return g1BelongsToHumongousRegion0(adr); 170 } 171 172 173 private native boolean g1BelongsToFreeRegion0(long adr); 174 public boolean g1BelongsToFreeRegion(long adr) { 175 if (adr == 0) { 176 throw new IllegalArgumentException("adr argument should not be null"); 177 } 178 return g1BelongsToFreeRegion0(adr); 179 } 180 181 public native long g1NumMaxRegions(); 182 public native long g1NumFreeRegions(); 183 public native int g1RegionSize(); 184 public native MemoryUsage g1AuxiliaryMemoryUsage(); 185 private native Object[] parseCommandLine0(String commandline, char delim, DiagnosticCommand[] args); 186 public Object[] parseCommandLine(String commandline, char delim, DiagnosticCommand[] args) { 187 Objects.requireNonNull(args); 188 return parseCommandLine0(commandline, delim, args); 189 } 190 191 // Parallel GC 192 public native long psVirtualSpaceAlignment(); 193 public native long psHeapGenerationAlignment(); 194 195 /** 196 * Enumerates old regions with liveness less than specified and produces some statistics 197 * @param liveness percent of region's liveness (live_objects / total_region_size * 100). 198 * @return long[3] array where long[0] - total count of old regions 199 * long[1] - total memory of old regions 200 * long[2] - lowest estimation of total memory of old regions to be freed (non-full 201 * regions are not included) 202 */ 203 public native long[] g1GetMixedGCInfo(int liveness); 204 205 // NMT 206 public native long NMTMalloc(long size); 207 public native void NMTFree(long mem); 208 public native long NMTReserveMemory(long size); 209 public native void NMTCommitMemory(long addr, long size); 210 public native void NMTUncommitMemory(long addr, long size); 211 public native void NMTReleaseMemory(long addr, long size); 212 public native long NMTMallocWithPseudoStack(long size, int index); 213 public native boolean NMTChangeTrackingLevel(); 214 public native int NMTGetHashSize(); 215 216 // Compiler 217 public native int matchesMethod(Executable method, String pattern); 218 public native int matchesInline(Executable method, String pattern); 219 public native boolean shouldPrintAssembly(Executable method, int comp_level); 220 public native int deoptimizeFrames(boolean makeNotEntrant); 221 public native void deoptimizeAll(); 222 223 public boolean isMethodCompiled(Executable method) { 224 return isMethodCompiled(method, false /*not osr*/); 225 } 226 private native boolean isMethodCompiled0(Executable method, boolean isOsr); 227 public boolean isMethodCompiled(Executable method, boolean isOsr){ 228 Objects.requireNonNull(method); 229 return isMethodCompiled0(method, isOsr); 230 } 231 public boolean isMethodCompilable(Executable method) { 232 return isMethodCompilable(method, -2 /*any*/); 233 } 234 public boolean isMethodCompilable(Executable method, int compLevel) { 235 return isMethodCompilable(method, compLevel, false /*not osr*/); 236 } 237 private native boolean isMethodCompilable0(Executable method, int compLevel, boolean isOsr); 238 public boolean isMethodCompilable(Executable method, int compLevel, boolean isOsr) { 239 Objects.requireNonNull(method); 240 return isMethodCompilable0(method, compLevel, isOsr); 241 } 242 private native boolean isMethodQueuedForCompilation0(Executable method); 243 public boolean isMethodQueuedForCompilation(Executable method) { 244 Objects.requireNonNull(method); 245 return isMethodQueuedForCompilation0(method); 246 } 247 // Determine if the compiler corresponding to the compilation level 'compLevel' 248 // and to the compilation context 'compilation_context' provides an intrinsic 249 // for the method 'method'. An intrinsic is available for method 'method' if: 250 // - the intrinsic is enabled (by using the appropriate command-line flag) and 251 // - the platform on which the VM is running provides the instructions necessary 252 // for the compiler to generate the intrinsic code. 253 // 254 // The compilation context is related to using the DisableIntrinsic flag on a 255 // per-method level, see hotspot/src/share/vm/compiler/abstractCompiler.hpp 256 // for more details. 257 public boolean isIntrinsicAvailable(Executable method, 258 Executable compilationContext, 259 int compLevel) { 260 Objects.requireNonNull(method); 261 return isIntrinsicAvailable0(method, compilationContext, compLevel); 262 } 263 // If usage of the DisableIntrinsic flag is not expected (or the usage can be ignored), 264 // use the below method that does not require the compilation context as argument. 265 public boolean isIntrinsicAvailable(Executable method, int compLevel) { 266 return isIntrinsicAvailable(method, null, compLevel); 267 } 268 private native boolean isIntrinsicAvailable0(Executable method, 269 Executable compilationContext, 270 int compLevel); 271 public int deoptimizeMethod(Executable method) { 272 return deoptimizeMethod(method, false /*not osr*/); 273 } 274 private native int deoptimizeMethod0(Executable method, boolean isOsr); 275 public int deoptimizeMethod(Executable method, boolean isOsr) { 276 Objects.requireNonNull(method); 277 return deoptimizeMethod0(method, isOsr); 278 } 279 public void makeMethodNotCompilable(Executable method) { 280 makeMethodNotCompilable(method, -2 /*any*/); 281 } 282 public void makeMethodNotCompilable(Executable method, int compLevel) { 283 makeMethodNotCompilable(method, compLevel, false /*not osr*/); 284 } 285 private native void makeMethodNotCompilable0(Executable method, int compLevel, boolean isOsr); 286 public void makeMethodNotCompilable(Executable method, int compLevel, boolean isOsr) { 287 Objects.requireNonNull(method); 288 makeMethodNotCompilable0(method, compLevel, isOsr); 289 } 290 public int getMethodCompilationLevel(Executable method) { 291 return getMethodCompilationLevel(method, false /*not ost*/); 292 } 293 private native int getMethodCompilationLevel0(Executable method, boolean isOsr); 294 public int getMethodCompilationLevel(Executable method, boolean isOsr) { 295 Objects.requireNonNull(method); 296 return getMethodCompilationLevel0(method, isOsr); 297 } 298 private native boolean testSetDontInlineMethod0(Executable method, boolean value); 299 public boolean testSetDontInlineMethod(Executable method, boolean value) { 300 Objects.requireNonNull(method); 301 return testSetDontInlineMethod0(method, value); 302 } 303 public int getCompileQueuesSize() { 304 return getCompileQueueSize(-2 /*any*/); 305 } 306 public native int getCompileQueueSize(int compLevel); 307 private native boolean testSetForceInlineMethod0(Executable method, boolean value); 308 public boolean testSetForceInlineMethod(Executable method, boolean value) { 309 Objects.requireNonNull(method); 310 return testSetForceInlineMethod0(method, value); 311 } 312 public boolean enqueueMethodForCompilation(Executable method, int compLevel) { 313 return enqueueMethodForCompilation(method, compLevel, -1 /*InvocationEntryBci*/); 314 } 315 private native boolean enqueueMethodForCompilation0(Executable method, int compLevel, int entry_bci); 316 public boolean enqueueMethodForCompilation(Executable method, int compLevel, int entry_bci) { 317 Objects.requireNonNull(method); 318 return enqueueMethodForCompilation0(method, compLevel, entry_bci); 319 } 320 private native boolean enqueueInitializerForCompilation0(Class<?> aClass, int compLevel); 321 public boolean enqueueInitializerForCompilation(Class<?> aClass, int compLevel) { 322 Objects.requireNonNull(aClass); 323 return enqueueInitializerForCompilation0(aClass, compLevel); 324 } 325 private native void clearMethodState0(Executable method); 326 public void clearMethodState(Executable method) { 327 Objects.requireNonNull(method); 328 clearMethodState0(method); 329 } 330 public native void lockCompilation(); 331 public native void unlockCompilation(); 332 private native int getMethodEntryBci0(Executable method); 333 public int getMethodEntryBci(Executable method) { 334 Objects.requireNonNull(method); 335 return getMethodEntryBci0(method); 336 } 337 private native Object[] getNMethod0(Executable method, boolean isOsr); 338 public Object[] getNMethod(Executable method, boolean isOsr) { 339 Objects.requireNonNull(method); 340 return getNMethod0(method, isOsr); 341 } 342 public native long allocateCodeBlob(int size, int type); 343 public long allocateCodeBlob(long size, int type) { 344 int intSize = (int) size; 345 if ((long) intSize != size || size < 0) { 346 throw new IllegalArgumentException( 347 "size argument has illegal value " + size); 348 } 349 return allocateCodeBlob( intSize, type); 350 } 351 public native void freeCodeBlob(long addr); 352 public native void forceNMethodSweep(); 353 public native Object[] getCodeHeapEntries(int type); 354 public native int getCompilationActivityMode(); 355 private native long getMethodData0(Executable method); 356 public long getMethodData(Executable method) { 357 Objects.requireNonNull(method); 358 return getMethodData0(method); 359 } 360 public native Object[] getCodeBlob(long addr); 361 362 private native void clearInlineCaches0(boolean preserve_static_stubs); 363 public void clearInlineCaches() { 364 clearInlineCaches0(false); 365 } 366 public void clearInlineCaches(boolean preserve_static_stubs) { 367 clearInlineCaches0(preserve_static_stubs); 368 } 369 370 // Intered strings 371 public native boolean isInStringTable(String str); 372 373 // Memory 374 public native void readReservedMemory(); 375 public native long allocateMetaspace(ClassLoader classLoader, long size); 376 public native void freeMetaspace(ClassLoader classLoader, long addr, long size); 377 public native long incMetaspaceCapacityUntilGC(long increment); 378 public native long metaspaceCapacityUntilGC(); 379 public native boolean metaspaceShouldConcurrentCollect(); 380 public native long metaspaceReserveAlignment(); 381 382 // Don't use these methods directly 383 // Use sun.hotspot.gc.GC class instead. 384 public native int currentGC(); 385 public native int allSupportedGC(); 386 public native boolean gcSelectedByErgo(); 387 388 // Force Young GC 389 public native void youngGC(); 390 391 // Force Full GC 392 public native void fullGC(); 393 394 // Returns true if the current GC supports control of its concurrent 395 // phase via requestConcurrentGCPhase(). If false, a request will 396 // always fail. 397 public native boolean supportsConcurrentGCPhaseControl(); 398 399 // Returns an array of concurrent phase names provided by this 400 // collector. These are the names recognized by 401 // requestConcurrentGCPhase(). 402 public native String[] getConcurrentGCPhases(); 403 404 // Attempt to put the collector into the indicated concurrent phase, 405 // and attempt to remain in that state until a new request is made. 406 // 407 // Returns immediately if already in the requested phase. 408 // Otherwise, waits until the phase is reached. 409 // 410 // Throws IllegalStateException if unsupported by the current collector. 411 // Throws NullPointerException if phase is null. 412 // Throws IllegalArgumentException if phase is not valid for the current collector. 413 public void requestConcurrentGCPhase(String phase) { 414 if (!supportsConcurrentGCPhaseControl()) { 415 throw new IllegalStateException("Concurrent GC phase control not supported"); 416 } else if (phase == null) { 417 throw new NullPointerException("null phase"); 418 } else if (!requestConcurrentGCPhase0(phase)) { 419 throw new IllegalArgumentException("Unknown concurrent GC phase: " + phase); 420 } 421 } 422 423 // Helper for requestConcurrentGCPhase(). Returns true if request 424 // succeeded, false if the phase is invalid. 425 private native boolean requestConcurrentGCPhase0(String phase); 426 427 // Method tries to start concurrent mark cycle. 428 // It returns false if CM Thread is always in concurrent cycle. 429 public native boolean g1StartConcMarkCycle(); 430 431 // Tests on ReservedSpace/VirtualSpace classes 432 public native int stressVirtualSpaceResize(long reservedSpaceSize, long magnitude, long iterations); 433 public native void runMemoryUnitTests(); 434 public native void readFromNoaccessArea(); 435 public native long getThreadStackSize(); 436 public native long getThreadRemainingStackSize(); 437 438 // CPU features 439 public native String getCPUFeatures(); 440 441 // Native extensions 442 public native long getHeapUsageForContext(int context); 443 public native long getHeapRegionCountForContext(int context); 444 private native int getContextForObject0(Object obj); 445 public int getContextForObject(Object obj) { 446 Objects.requireNonNull(obj); 447 return getContextForObject0(obj); 448 } 449 public native void printRegionInfo(int context); 450 451 // VM flags 452 public native boolean isConstantVMFlag(String name); 453 public native boolean isLockedVMFlag(String name); 454 public native void setBooleanVMFlag(String name, boolean value); 455 public native void setIntVMFlag(String name, long value); 456 public native void setUintVMFlag(String name, long value); 457 public native void setIntxVMFlag(String name, long value); 458 public native void setUintxVMFlag(String name, long value); 459 public native void setUint64VMFlag(String name, long value); 460 public native void setSizeTVMFlag(String name, long value); 461 public native void setStringVMFlag(String name, String value); 462 public native void setDoubleVMFlag(String name, double value); 463 public native Boolean getBooleanVMFlag(String name); 464 public native Long getIntVMFlag(String name); 465 public native Long getUintVMFlag(String name); 466 public native Long getIntxVMFlag(String name); 467 public native Long getUintxVMFlag(String name); 468 public native Long getUint64VMFlag(String name); 469 public native Long getSizeTVMFlag(String name); 470 public native String getStringVMFlag(String name); 471 public native Double getDoubleVMFlag(String name); 472 private final List<Function<String,Object>> flagsGetters = Arrays.asList( 473 this::getBooleanVMFlag, this::getIntVMFlag, this::getUintVMFlag, 474 this::getIntxVMFlag, this::getUintxVMFlag, this::getUint64VMFlag, 475 this::getSizeTVMFlag, this::getStringVMFlag, this::getDoubleVMFlag); 476 477 public Object getVMFlag(String name) { 478 return flagsGetters.stream() 479 .map(f -> f.apply(name)) 480 .filter(x -> x != null) 481 .findAny() 482 .orElse(null); 483 } 484 485 // Jigsaw 486 public native void DefineModule(Object module, boolean is_open, String version, 487 String location, Object[] packages); 488 public native void AddModuleExports(Object from_module, String pkg, Object to_module); 489 public native void AddReadsModule(Object from_module, Object source_module); 490 public native void AddModuleExportsToAllUnnamed(Object module, String pkg); 491 public native void AddModuleExportsToAll(Object module, String pkg); 492 493 public native int getOffsetForName0(String name); 494 public int getOffsetForName(String name) throws Exception { 495 int offset = getOffsetForName0(name); 496 if (offset == -1) { 497 throw new RuntimeException(name + " not found"); 498 } 499 return offset; 500 } 501 public native Boolean getMethodBooleanOption(Executable method, String name); 502 public native Long getMethodIntxOption(Executable method, String name); 503 public native Long getMethodUintxOption(Executable method, String name); 504 public native Double getMethodDoubleOption(Executable method, String name); 505 public native String getMethodStringOption(Executable method, String name); 506 private final List<BiFunction<Executable,String,Object>> methodOptionGetters 507 = Arrays.asList(this::getMethodBooleanOption, this::getMethodIntxOption, 508 this::getMethodUintxOption, this::getMethodDoubleOption, 509 this::getMethodStringOption); 510 511 public Object getMethodOption(Executable method, String name) { 512 return methodOptionGetters.stream() 513 .map(f -> f.apply(method, name)) 514 .filter(x -> x != null) 515 .findAny() 516 .orElse(null); 517 } 518 519 // Safepoint Checking 520 public native void assertMatchingSafepointCalls(boolean mutexSafepointValue, boolean attemptedNoSafepointValue); 521 522 // Sharing & archiving 523 public native boolean isShared(Object o); 524 public native boolean isSharedClass(Class<?> c); 525 public native boolean areSharedStringsIgnored(); 526 public native boolean isCDSIncludedInVmBuild(); 527 public native Object getResolvedReferences(Class<?> c); 528 529 // Compiler Directive 530 public native int addCompilerDirective(String compDirect); 531 public native void removeCompilerDirective(int count); 532} 533