1 /*
2 * Copyright (c) 2012, 2020, 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 package sun.hotspot;
25
26 import java.lang.management.MemoryUsage;
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.security.BasicPermission;
33 import java.util.Objects;
34
35 import sun.hotspot.parser.DiagnosticCommand;
36
37 public class WhiteBox {
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 private native long getObjectAddress0(Object o);
76 public long getObjectAddress(Object o) {
77 Objects.requireNonNull(o);
78 return getObjectAddress0(o);
79 }
80
81 public native int getHeapOopSize();
82 public native int getVMPageSize();
83 public native long getVMAllocationGranularity();
84 public native long getVMLargePageSize();
85 public native long getHeapSpaceAlignment();
86 public native long getHeapAlignment();
87
88 private native boolean isObjectInOldGen0(Object o);
89 public boolean isObjectInOldGen(Object o) {
90 Objects.requireNonNull(o);
91 return isObjectInOldGen0(o);
92 }
93
94 private native long getObjectSize0(Object o);
95 public long getObjectSize(Object o) {
96 Objects.requireNonNull(o);
97 return getObjectSize0(o);
98 }
99
100 // Runtime
101 // Make sure class name is in the correct format
102 public boolean isClassAlive(String name) {
103 return isClassAlive0(name.replace('.', '/'));
104 }
105 private native boolean isClassAlive0(String name);
106 public native int getSymbolRefcount(String name);
107
108 private native boolean isMonitorInflated0(Object obj);
109 public boolean isMonitorInflated(Object obj) {
110 Objects.requireNonNull(obj);
111 return isMonitorInflated0(obj);
112 }
113
114 public native void forceSafepoint();
115
116 private native long getConstantPool0(Class<?> aClass);
117 public long getConstantPool(Class<?> aClass) {
118 Objects.requireNonNull(aClass);
119 return getConstantPool0(aClass);
120 }
121
122 private native int getConstantPoolCacheIndexTag0();
123 public int getConstantPoolCacheIndexTag() {
124 return getConstantPoolCacheIndexTag0();
125 }
126
127 private native int getConstantPoolCacheLength0(Class<?> aClass);
128 public int getConstantPoolCacheLength(Class<?> aClass) {
129 Objects.requireNonNull(aClass);
130 return getConstantPoolCacheLength0(aClass);
131 }
132
133 private native int remapInstructionOperandFromCPCache0(Class<?> aClass, int index);
134 public int remapInstructionOperandFromCPCache(Class<?> aClass, int index) {
135 Objects.requireNonNull(aClass);
136 return remapInstructionOperandFromCPCache0(aClass, index);
137 }
138
139 private native int encodeConstantPoolIndyIndex0(int index);
140 public int encodeConstantPoolIndyIndex(int index) {
141 return encodeConstantPoolIndyIndex0(index);
142 }
143
144 // JVMTI
145 private native void addToBootstrapClassLoaderSearch0(String segment);
146 public void addToBootstrapClassLoaderSearch(String segment){
147 Objects.requireNonNull(segment);
148 addToBootstrapClassLoaderSearch0(segment);
149 }
150
151 private native void addToSystemClassLoaderSearch0(String segment);
152 public void addToSystemClassLoaderSearch(String segment) {
153 Objects.requireNonNull(segment);
154 addToSystemClassLoaderSearch0(segment);
155 }
156
157 // G1
158 public native boolean g1InConcurrentMark();
159 private native boolean g1IsHumongous0(Object o);
160 public boolean g1IsHumongous(Object o) {
161 Objects.requireNonNull(o);
162 return g1IsHumongous0(o);
163 }
164
165 private native boolean g1BelongsToHumongousRegion0(long adr);
166 public boolean g1BelongsToHumongousRegion(long adr) {
167 if (adr == 0) {
168 throw new IllegalArgumentException("adr argument should not be null");
169 }
170 return g1BelongsToHumongousRegion0(adr);
171 }
172
173
174 private native boolean g1BelongsToFreeRegion0(long adr);
175 public boolean g1BelongsToFreeRegion(long adr) {
176 if (adr == 0) {
177 throw new IllegalArgumentException("adr argument should not be null");
178 }
179 return g1BelongsToFreeRegion0(adr);
180 }
181
182 public native long g1NumMaxRegions();
183 public native long g1NumFreeRegions();
184 public native int g1RegionSize();
185 public native long dramReservedStart();
186 public native long dramReservedEnd();
187 public native long nvdimmReservedStart();
188 public native long nvdimmReservedEnd();
189 public native MemoryUsage g1AuxiliaryMemoryUsage();
190 private native Object[] parseCommandLine0(String commandline, char delim, DiagnosticCommand[] args);
191 public Object[] parseCommandLine(String commandline, char delim, DiagnosticCommand[] args) {
192 Objects.requireNonNull(args);
193 return parseCommandLine0(commandline, delim, args);
194 }
195
196 public native int g1ActiveMemoryNodeCount();
197 public native int[] g1MemoryNodeIds();
198
199 // Parallel GC
200 public native long psVirtualSpaceAlignment();
201 public native long psHeapGenerationAlignment();
202
203 /**
204 * Enumerates old regions with liveness less than specified and produces some statistics
205 * @param liveness percent of region's liveness (live_objects / total_region_size * 100).
206 * @return long[3] array where long[0] - total count of old regions
207 * long[1] - total memory of old regions
208 * long[2] - lowest estimation of total memory of old regions to be freed (non-full
209 * regions are not included)
210 */
211 public native long[] g1GetMixedGCInfo(int liveness);
212
213 // NMT
214 public native long NMTMalloc(long size);
215 public native void NMTFree(long mem);
216 public native long NMTReserveMemory(long size);
217 public native long NMTAttemptReserveMemoryAt(long addr, long size);
218 public native void NMTCommitMemory(long addr, long size);
219 public native void NMTUncommitMemory(long addr, long size);
220 public native void NMTReleaseMemory(long addr, long size);
221 public native long NMTMallocWithPseudoStack(long size, int index);
222 public native long NMTMallocWithPseudoStackAndType(long size, int index, int type);
223 public native boolean NMTChangeTrackingLevel();
224 public native int NMTGetHashSize();
225 public native long NMTNewArena(long initSize);
226 public native void NMTFreeArena(long arena);
227 public native void NMTArenaMalloc(long arena, long size);
228
229 // Compiler
230 public native boolean isC2OrJVMCIIncludedInVmBuild();
231
232 public native int matchesMethod(Executable method, String pattern);
233 public native int matchesInline(Executable method, String pattern);
234 public native boolean shouldPrintAssembly(Executable method, int comp_level);
235 public native int deoptimizeFrames(boolean makeNotEntrant);
236 public native void deoptimizeAll();
237
238 public boolean isMethodCompiled(Executable method) {
239 return isMethodCompiled(method, false /*not osr*/);
240 }
241 private native boolean isMethodCompiled0(Executable method, boolean isOsr);
242 public boolean isMethodCompiled(Executable method, boolean isOsr){
243 Objects.requireNonNull(method);
244 return isMethodCompiled0(method, isOsr);
245 }
246 public boolean isMethodCompilable(Executable method) {
247 return isMethodCompilable(method, -2 /*any*/);
248 }
249 public boolean isMethodCompilable(Executable method, int compLevel) {
250 return isMethodCompilable(method, compLevel, false /*not osr*/);
251 }
252 private native boolean isMethodCompilable0(Executable method, int compLevel, boolean isOsr);
253 public boolean isMethodCompilable(Executable method, int compLevel, boolean isOsr) {
254 Objects.requireNonNull(method);
255 return isMethodCompilable0(method, compLevel, isOsr);
256 }
257 private native boolean isMethodQueuedForCompilation0(Executable method);
258 public boolean isMethodQueuedForCompilation(Executable method) {
259 Objects.requireNonNull(method);
260 return isMethodQueuedForCompilation0(method);
261 }
262 // Determine if the compiler corresponding to the compilation level 'compLevel'
263 // and to the compilation context 'compilation_context' provides an intrinsic
264 // for the method 'method'. An intrinsic is available for method 'method' if:
265 // - the intrinsic is enabled (by using the appropriate command-line flag) and
266 // - the platform on which the VM is running provides the instructions necessary
267 // for the compiler to generate the intrinsic code.
268 //
269 // The compilation context is related to using the DisableIntrinsic flag on a
270 // per-method level, see hotspot/src/share/vm/compiler/abstractCompiler.hpp
271 // for more details.
272 public boolean isIntrinsicAvailable(Executable method,
273 Executable compilationContext,
274 int compLevel) {
275 Objects.requireNonNull(method);
276 return isIntrinsicAvailable0(method, compilationContext, compLevel);
277 }
278 // If usage of the DisableIntrinsic flag is not expected (or the usage can be ignored),
279 // use the below method that does not require the compilation context as argument.
280 public boolean isIntrinsicAvailable(Executable method, int compLevel) {
281 return isIntrinsicAvailable(method, null, compLevel);
282 }
283 private native boolean isIntrinsicAvailable0(Executable method,
284 Executable compilationContext,
285 int compLevel);
286 public int deoptimizeMethod(Executable method) {
287 return deoptimizeMethod(method, false /*not osr*/);
288 }
289 private native int deoptimizeMethod0(Executable method, boolean isOsr);
290 public int deoptimizeMethod(Executable method, boolean isOsr) {
291 Objects.requireNonNull(method);
292 return deoptimizeMethod0(method, isOsr);
293 }
294 public void makeMethodNotCompilable(Executable method) {
295 makeMethodNotCompilable(method, -2 /*any*/);
296 }
297 public void makeMethodNotCompilable(Executable method, int compLevel) {
298 makeMethodNotCompilable(method, compLevel, false /*not osr*/);
299 }
300 private native void makeMethodNotCompilable0(Executable method, int compLevel, boolean isOsr);
301 public void makeMethodNotCompilable(Executable method, int compLevel, boolean isOsr) {
302 Objects.requireNonNull(method);
303 makeMethodNotCompilable0(method, compLevel, isOsr);
304 }
305 public int getMethodCompilationLevel(Executable method) {
306 return getMethodCompilationLevel(method, false /*not ost*/);
307 }
308 private native int getMethodCompilationLevel0(Executable method, boolean isOsr);
309 public int getMethodCompilationLevel(Executable method, boolean isOsr) {
310 Objects.requireNonNull(method);
311 return getMethodCompilationLevel0(method, isOsr);
312 }
313 private native boolean testSetDontInlineMethod0(Executable method, boolean value);
314 public boolean testSetDontInlineMethod(Executable method, boolean value) {
315 Objects.requireNonNull(method);
316 return testSetDontInlineMethod0(method, value);
317 }
318 public int getCompileQueuesSize() {
319 return getCompileQueueSize(-2 /*any*/);
320 }
321 public native int getCompileQueueSize(int compLevel);
322 private native boolean testSetForceInlineMethod0(Executable method, boolean value);
323 public boolean testSetForceInlineMethod(Executable method, boolean value) {
324 Objects.requireNonNull(method);
325 return testSetForceInlineMethod0(method, value);
326 }
327 public boolean enqueueMethodForCompilation(Executable method, int compLevel) {
328 return enqueueMethodForCompilation(method, compLevel, -1 /*InvocationEntryBci*/);
329 }
330 private native boolean enqueueMethodForCompilation0(Executable method, int compLevel, int entry_bci);
331 public boolean enqueueMethodForCompilation(Executable method, int compLevel, int entry_bci) {
332 Objects.requireNonNull(method);
333 return enqueueMethodForCompilation0(method, compLevel, entry_bci);
334 }
335 private native boolean enqueueInitializerForCompilation0(Class<?> aClass, int compLevel);
336 public boolean enqueueInitializerForCompilation(Class<?> aClass, int compLevel) {
337 Objects.requireNonNull(aClass);
338 return enqueueInitializerForCompilation0(aClass, compLevel);
339 }
340 private native void clearMethodState0(Executable method);
341 public native void markMethodProfiled(Executable method);
342 public void clearMethodState(Executable method) {
343 Objects.requireNonNull(method);
344 clearMethodState0(method);
345 }
346 public native void lockCompilation();
347 public native void unlockCompilation();
348 private native int getMethodEntryBci0(Executable method);
349 public int getMethodEntryBci(Executable method) {
350 Objects.requireNonNull(method);
351 return getMethodEntryBci0(method);
352 }
353 private native Object[] getNMethod0(Executable method, boolean isOsr);
354 public Object[] getNMethod(Executable method, boolean isOsr) {
355 Objects.requireNonNull(method);
356 return getNMethod0(method, isOsr);
357 }
358 public native long allocateCodeBlob(int size, int type);
359 public long allocateCodeBlob(long size, int type) {
360 int intSize = (int) size;
361 if ((long) intSize != size || size < 0) {
362 throw new IllegalArgumentException(
363 "size argument has illegal value " + size);
364 }
365 return allocateCodeBlob( intSize, type);
366 }
367 public native void freeCodeBlob(long addr);
368 public native void forceNMethodSweep();
369 public native Object[] getCodeHeapEntries(int type);
370 public native int getCompilationActivityMode();
371 private native long getMethodData0(Executable method);
372 public long getMethodData(Executable method) {
373 Objects.requireNonNull(method);
374 return getMethodData0(method);
375 }
376 public native Object[] getCodeBlob(long addr);
377
378 private native void clearInlineCaches0(boolean preserve_static_stubs);
379 public void clearInlineCaches() {
380 clearInlineCaches0(false);
381 }
382 public void clearInlineCaches(boolean preserve_static_stubs) {
383 clearInlineCaches0(preserve_static_stubs);
384 }
385
386 // Intered strings
387 public native boolean isInStringTable(String str);
388
389 // Memory
390 public native void readReservedMemory();
391 public native long allocateMetaspace(ClassLoader classLoader, long size);
392 public native void freeMetaspace(ClassLoader classLoader, long addr, long size);
393 public native long incMetaspaceCapacityUntilGC(long increment);
394 public native long metaspaceCapacityUntilGC();
395 public native long metaspaceReserveAlignment();
396
397 // Don't use these methods directly
398 // Use sun.hotspot.gc.GC class instead.
399 public native boolean isGCSupported(int name);
400 public native boolean isGCSelected(int name);
401 public native boolean isGCSelectedErgonomically();
402
403 // Force Young GC
404 public native void youngGC();
405
406 // Force Full GC
407 public native void fullGC();
408
409 // Returns true if the current GC supports control of its concurrent
410 // phase via requestConcurrentGCPhase(). If false, a request will
411 // always fail.
412 public native boolean supportsConcurrentGCPhaseControl();
413
414 // Attempt to put the collector into the indicated concurrent phase,
415 // and attempt to remain in that state until a new request is made.
416 //
417 // Returns immediately if already in the requested phase.
418 // Otherwise, waits until the phase is reached.
419 //
420 // Throws IllegalStateException if unsupported by the current collector.
421 // Throws NullPointerException if phase is null.
422 // Throws IllegalArgumentException if phase is not valid for the current collector.
423 public void requestConcurrentGCPhase(String phase) {
424 if (!supportsConcurrentGCPhaseControl()) {
425 throw new IllegalStateException("Concurrent GC phase control not supported");
426 } else if (phase == null) {
427 throw new NullPointerException("null phase");
428 } else if (!requestConcurrentGCPhase0(phase)) {
429 throw new IllegalArgumentException("Unknown concurrent GC phase: " + phase);
430 }
431 }
432
433 // Helper for requestConcurrentGCPhase(). Returns true if request
434 // succeeded, false if the phase is invalid.
435 private native boolean requestConcurrentGCPhase0(String phase);
436
437 // Method tries to start concurrent mark cycle.
438 // It returns false if CM Thread is always in concurrent cycle.
439 public native boolean g1StartConcMarkCycle();
440
441 // Tests on ReservedSpace/VirtualSpace classes
442 public native int stressVirtualSpaceResize(long reservedSpaceSize, long magnitude, long iterations);
443 public native void runMemoryUnitTests();
444 public native void readFromNoaccessArea();
445 public native long getThreadStackSize();
446 public native long getThreadRemainingStackSize();
447
448 // CPU features
449 public native String getCPUFeatures();
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 public native void assertSpecialLock(boolean allowVMBlock, boolean safepointCheck);
522
523 // Sharing & archiving
524 public native String getDefaultArchivePath();
525 public native boolean cdsMemoryMappingFailed();
526 public native boolean isSharingEnabled();
527 public native boolean isShared(Object o);
528 public native boolean isSharedClass(Class<?> c);
529 public native boolean areSharedStringsIgnored();
530 public native boolean isCDSIncludedInVmBuild();
531 public native boolean isJFRIncludedInVmBuild();
532 public native boolean isJavaHeapArchiveSupported();
533 public native Object getResolvedReferences(Class<?> c);
534 public native void linkClass(Class<?> c);
535 public native boolean areOpenArchiveHeapObjectsMapped();
536
537 // Compiler Directive
538 public native int addCompilerDirective(String compDirect);
539 public native void removeCompilerDirective(int count);
540
541 // Handshakes
542 public native int handshakeWalkStack(Thread t, boolean all_threads);
543
544 // Returns true on linux if library has the noexecstack flag set.
545 public native boolean checkLibSpecifiesNoexecstack(String libfilename);
546
547 // Container testing
548 public native boolean isContainerized();
549 public native void printOsInfo();
550
551 // Decoder
552 public native void disableElfSectionCache();
553
554 // Resolved Method Table
555 public native long resolvedMethodItemsCount();
556
557 // Protection Domain Table
558 public native int protectionDomainRemovedCount();
559
560 // Number of loaded AOT libraries
561 public native int aotLibrariesCount();
562 }