1 /*
2 * Copyright (c) 2012, 2018, 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 MemoryUsage g1AuxiliaryMemoryUsage();
186 private native Object[] parseCommandLine0(String commandline, char delim, DiagnosticCommand[] args);
187 public Object[] parseCommandLine(String commandline, char delim, DiagnosticCommand[] args) {
188 Objects.requireNonNull(args);
189 return parseCommandLine0(commandline, delim, args);
190 }
191
192 // Parallel GC
193 public native long psVirtualSpaceAlignment();
194 public native long psHeapGenerationAlignment();
195
196 /**
197 * Enumerates old regions with liveness less than specified and produces some statistics
198 * @param liveness percent of region's liveness (live_objects / total_region_size * 100).
199 * @return long[3] array where long[0] - total count of old regions
200 * long[1] - total memory of old regions
201 * long[2] - lowest estimation of total memory of old regions to be freed (non-full
202 * regions are not included)
203 */
204 public native long[] g1GetMixedGCInfo(int liveness);
205
206 // NMT
207 public native long NMTMalloc(long size);
208 public native void NMTFree(long mem);
209 public native long NMTReserveMemory(long size);
210 public native long NMTAttemptReserveMemoryAt(long addr, long size);
211 public native void NMTCommitMemory(long addr, long size);
212 public native void NMTUncommitMemory(long addr, long size);
213 public native void NMTReleaseMemory(long addr, long size);
214 public native long NMTMallocWithPseudoStack(long size, int index);
215 public native boolean NMTChangeTrackingLevel();
216 public native int NMTGetHashSize();
217
218 // Compiler
219 public native int matchesMethod(Executable method, String pattern);
220 public native int matchesInline(Executable method, String pattern);
221 public native boolean shouldPrintAssembly(Executable method, int comp_level);
222 public native int deoptimizeFrames(boolean makeNotEntrant);
223 public native void deoptimizeAll();
224
225 public boolean isMethodCompiled(Executable method) {
226 return isMethodCompiled(method, false /*not osr*/);
227 }
228 private native boolean isMethodCompiled0(Executable method, boolean isOsr);
229 public boolean isMethodCompiled(Executable method, boolean isOsr){
230 Objects.requireNonNull(method);
231 return isMethodCompiled0(method, isOsr);
232 }
233 public boolean isMethodCompilable(Executable method) {
234 return isMethodCompilable(method, -2 /*any*/);
235 }
236 public boolean isMethodCompilable(Executable method, int compLevel) {
237 return isMethodCompilable(method, compLevel, false /*not osr*/);
238 }
239 private native boolean isMethodCompilable0(Executable method, int compLevel, boolean isOsr);
240 public boolean isMethodCompilable(Executable method, int compLevel, boolean isOsr) {
241 Objects.requireNonNull(method);
242 return isMethodCompilable0(method, compLevel, isOsr);
243 }
244 private native boolean isMethodQueuedForCompilation0(Executable method);
245 public boolean isMethodQueuedForCompilation(Executable method) {
246 Objects.requireNonNull(method);
247 return isMethodQueuedForCompilation0(method);
248 }
249 // Determine if the compiler corresponding to the compilation level 'compLevel'
250 // and to the compilation context 'compilation_context' provides an intrinsic
251 // for the method 'method'. An intrinsic is available for method 'method' if:
252 // - the intrinsic is enabled (by using the appropriate command-line flag) and
253 // - the platform on which the VM is running provides the instructions necessary
254 // for the compiler to generate the intrinsic code.
255 //
256 // The compilation context is related to using the DisableIntrinsic flag on a
257 // per-method level, see hotspot/src/share/vm/compiler/abstractCompiler.hpp
258 // for more details.
259 public boolean isIntrinsicAvailable(Executable method,
260 Executable compilationContext,
261 int compLevel) {
262 Objects.requireNonNull(method);
263 return isIntrinsicAvailable0(method, compilationContext, compLevel);
264 }
265 // If usage of the DisableIntrinsic flag is not expected (or the usage can be ignored),
266 // use the below method that does not require the compilation context as argument.
267 public boolean isIntrinsicAvailable(Executable method, int compLevel) {
268 return isIntrinsicAvailable(method, null, compLevel);
269 }
270 private native boolean isIntrinsicAvailable0(Executable method,
271 Executable compilationContext,
272 int compLevel);
273 public int deoptimizeMethod(Executable method) {
274 return deoptimizeMethod(method, false /*not osr*/);
275 }
276 private native int deoptimizeMethod0(Executable method, boolean isOsr);
277 public int deoptimizeMethod(Executable method, boolean isOsr) {
278 Objects.requireNonNull(method);
279 return deoptimizeMethod0(method, isOsr);
280 }
281 public void makeMethodNotCompilable(Executable method) {
282 makeMethodNotCompilable(method, -2 /*any*/);
283 }
284 public void makeMethodNotCompilable(Executable method, int compLevel) {
285 makeMethodNotCompilable(method, compLevel, false /*not osr*/);
286 }
287 private native void makeMethodNotCompilable0(Executable method, int compLevel, boolean isOsr);
288 public void makeMethodNotCompilable(Executable method, int compLevel, boolean isOsr) {
289 Objects.requireNonNull(method);
290 makeMethodNotCompilable0(method, compLevel, isOsr);
291 }
292 public int getMethodCompilationLevel(Executable method) {
293 return getMethodCompilationLevel(method, false /*not ost*/);
294 }
295 private native int getMethodCompilationLevel0(Executable method, boolean isOsr);
296 public int getMethodCompilationLevel(Executable method, boolean isOsr) {
297 Objects.requireNonNull(method);
298 return getMethodCompilationLevel0(method, isOsr);
299 }
300 private native boolean testSetDontInlineMethod0(Executable method, boolean value);
301 public boolean testSetDontInlineMethod(Executable method, boolean value) {
302 Objects.requireNonNull(method);
303 return testSetDontInlineMethod0(method, value);
304 }
305 public int getCompileQueuesSize() {
306 return getCompileQueueSize(-2 /*any*/);
307 }
308 public native int getCompileQueueSize(int compLevel);
309 private native boolean testSetForceInlineMethod0(Executable method, boolean value);
310 public boolean testSetForceInlineMethod(Executable method, boolean value) {
311 Objects.requireNonNull(method);
312 return testSetForceInlineMethod0(method, value);
313 }
314 public boolean enqueueMethodForCompilation(Executable method, int compLevel) {
315 return enqueueMethodForCompilation(method, compLevel, -1 /*InvocationEntryBci*/);
316 }
317 private native boolean enqueueMethodForCompilation0(Executable method, int compLevel, int entry_bci);
318 public boolean enqueueMethodForCompilation(Executable method, int compLevel, int entry_bci) {
319 Objects.requireNonNull(method);
320 return enqueueMethodForCompilation0(method, compLevel, entry_bci);
321 }
322 private native boolean enqueueInitializerForCompilation0(Class<?> aClass, int compLevel);
323 public boolean enqueueInitializerForCompilation(Class<?> aClass, int compLevel) {
324 Objects.requireNonNull(aClass);
325 return enqueueInitializerForCompilation0(aClass, compLevel);
326 }
327 private native void clearMethodState0(Executable method);
328 public void clearMethodState(Executable method) {
329 Objects.requireNonNull(method);
330 clearMethodState0(method);
331 }
332 public native void lockCompilation();
333 public native void unlockCompilation();
334 private native int getMethodEntryBci0(Executable method);
335 public int getMethodEntryBci(Executable method) {
336 Objects.requireNonNull(method);
337 return getMethodEntryBci0(method);
338 }
339 private native Object[] getNMethod0(Executable method, boolean isOsr);
340 public Object[] getNMethod(Executable method, boolean isOsr) {
341 Objects.requireNonNull(method);
342 return getNMethod0(method, isOsr);
343 }
344 public native long allocateCodeBlob(int size, int type);
345 public long allocateCodeBlob(long size, int type) {
346 int intSize = (int) size;
347 if ((long) intSize != size || size < 0) {
348 throw new IllegalArgumentException(
349 "size argument has illegal value " + size);
350 }
351 return allocateCodeBlob( intSize, type);
352 }
353 public native void freeCodeBlob(long addr);
354 public native void forceNMethodSweep();
355 public native Object[] getCodeHeapEntries(int type);
356 public native int getCompilationActivityMode();
357 private native long getMethodData0(Executable method);
358 public long getMethodData(Executable method) {
359 Objects.requireNonNull(method);
360 return getMethodData0(method);
361 }
362 public native Object[] getCodeBlob(long addr);
363
364 private native void clearInlineCaches0(boolean preserve_static_stubs);
365 public void clearInlineCaches() {
366 clearInlineCaches0(false);
367 }
368 public void clearInlineCaches(boolean preserve_static_stubs) {
369 clearInlineCaches0(preserve_static_stubs);
370 }
371
372 // Intered strings
373 public native boolean isInStringTable(String str);
374
375 // Memory
376 public native void readReservedMemory();
377 public native long allocateMetaspace(ClassLoader classLoader, long size);
378 public native void freeMetaspace(ClassLoader classLoader, long addr, long size);
379 public native long incMetaspaceCapacityUntilGC(long increment);
380 public native long metaspaceCapacityUntilGC();
381 public native boolean metaspaceShouldConcurrentCollect();
382 public native long metaspaceReserveAlignment();
383
384 // Don't use these methods directly
385 // Use sun.hotspot.gc.GC class instead.
386 public native boolean isGCSupported(int name);
387 public native boolean isGCSelected(int name);
388 public native boolean isGCSelectedErgonomically();
389
390 // Force Young GC
391 public native void youngGC();
392
393 // Force Full GC
394 public native void fullGC();
395
396 // Returns true if the current GC supports control of its concurrent
397 // phase via requestConcurrentGCPhase(). If false, a request will
398 // always fail.
399 public native boolean supportsConcurrentGCPhaseControl();
400
401 // Returns an array of concurrent phase names provided by this
402 // collector. These are the names recognized by
403 // requestConcurrentGCPhase().
404 public native String[] getConcurrentGCPhases();
405
406 // Attempt to put the collector into the indicated concurrent phase,
407 // and attempt to remain in that state until a new request is made.
408 //
409 // Returns immediately if already in the requested phase.
410 // Otherwise, waits until the phase is reached.
411 //
412 // Throws IllegalStateException if unsupported by the current collector.
413 // Throws NullPointerException if phase is null.
414 // Throws IllegalArgumentException if phase is not valid for the current collector.
415 public void requestConcurrentGCPhase(String phase) {
416 if (!supportsConcurrentGCPhaseControl()) {
417 throw new IllegalStateException("Concurrent GC phase control not supported");
418 } else if (phase == null) {
419 throw new NullPointerException("null phase");
420 } else if (!requestConcurrentGCPhase0(phase)) {
421 throw new IllegalArgumentException("Unknown concurrent GC phase: " + phase);
422 }
423 }
424
425 // Helper for requestConcurrentGCPhase(). Returns true if request
426 // succeeded, false if the phase is invalid.
427 private native boolean requestConcurrentGCPhase0(String phase);
428
429 // Method tries to start concurrent mark cycle.
430 // It returns false if CM Thread is always in concurrent cycle.
431 public native boolean g1StartConcMarkCycle();
432
433 // Tests on ReservedSpace/VirtualSpace classes
434 public native int stressVirtualSpaceResize(long reservedSpaceSize, long magnitude, long iterations);
435 public native void runMemoryUnitTests();
436 public native void readFromNoaccessArea();
437 public native long getThreadStackSize();
438 public native long getThreadRemainingStackSize();
439
440 // CPU features
441 public native String getCPUFeatures();
442
443 // VM flags
444 public native boolean isConstantVMFlag(String name);
445 public native boolean isLockedVMFlag(String name);
446 public native void setBooleanVMFlag(String name, boolean value);
447 public native void setIntVMFlag(String name, long value);
448 public native void setUintVMFlag(String name, long value);
449 public native void setIntxVMFlag(String name, long value);
450 public native void setUintxVMFlag(String name, long value);
451 public native void setUint64VMFlag(String name, long value);
452 public native void setSizeTVMFlag(String name, long value);
453 public native void setStringVMFlag(String name, String value);
454 public native void setDoubleVMFlag(String name, double value);
455 public native Boolean getBooleanVMFlag(String name);
456 public native Long getIntVMFlag(String name);
457 public native Long getUintVMFlag(String name);
458 public native Long getIntxVMFlag(String name);
459 public native Long getUintxVMFlag(String name);
460 public native Long getUint64VMFlag(String name);
461 public native Long getSizeTVMFlag(String name);
462 public native String getStringVMFlag(String name);
463 public native Double getDoubleVMFlag(String name);
464 private final List<Function<String,Object>> flagsGetters = Arrays.asList(
465 this::getBooleanVMFlag, this::getIntVMFlag, this::getUintVMFlag,
466 this::getIntxVMFlag, this::getUintxVMFlag, this::getUint64VMFlag,
467 this::getSizeTVMFlag, this::getStringVMFlag, this::getDoubleVMFlag);
468
469 public Object getVMFlag(String name) {
470 return flagsGetters.stream()
471 .map(f -> f.apply(name))
472 .filter(x -> x != null)
473 .findAny()
474 .orElse(null);
475 }
476
477 // Jigsaw
478 public native void DefineModule(Object module, boolean is_open, String version,
479 String location, Object[] packages);
480 public native void AddModuleExports(Object from_module, String pkg, Object to_module);
481 public native void AddReadsModule(Object from_module, Object source_module);
482 public native void AddModuleExportsToAllUnnamed(Object module, String pkg);
483 public native void AddModuleExportsToAll(Object module, String pkg);
484
485 public native int getOffsetForName0(String name);
486 public int getOffsetForName(String name) throws Exception {
487 int offset = getOffsetForName0(name);
488 if (offset == -1) {
489 throw new RuntimeException(name + " not found");
490 }
491 return offset;
492 }
493 public native Boolean getMethodBooleanOption(Executable method, String name);
494 public native Long getMethodIntxOption(Executable method, String name);
495 public native Long getMethodUintxOption(Executable method, String name);
496 public native Double getMethodDoubleOption(Executable method, String name);
497 public native String getMethodStringOption(Executable method, String name);
498 private final List<BiFunction<Executable,String,Object>> methodOptionGetters
499 = Arrays.asList(this::getMethodBooleanOption, this::getMethodIntxOption,
500 this::getMethodUintxOption, this::getMethodDoubleOption,
501 this::getMethodStringOption);
502
503 public Object getMethodOption(Executable method, String name) {
504 return methodOptionGetters.stream()
505 .map(f -> f.apply(method, name))
506 .filter(x -> x != null)
507 .findAny()
508 .orElse(null);
509 }
510
511 // Safepoint Checking
512 public native void assertMatchingSafepointCalls(boolean mutexSafepointValue, boolean attemptedNoSafepointValue);
513
514 // Sharing & archiving
515 public native String getDefaultArchivePath();
516 public native boolean isSharingEnabled();
517 public native boolean isShared(Object o);
518 public native boolean isSharedClass(Class<?> c);
519 public native boolean areSharedStringsIgnored();
520 public native boolean isCDSIncludedInVmBuild();
521 public native boolean isJFRIncludedInVmBuild();
522 public native boolean isJavaHeapArchiveSupported();
523 public native Object getResolvedReferences(Class<?> c);
524 public native boolean areOpenArchiveHeapObjectsMapped();
525
526 // Compiler Directive
527 public native int addCompilerDirective(String compDirect);
528 public native void removeCompilerDirective(int count);
529
530 // Handshakes
531 public native int handshakeWalkStack(Thread t, boolean all_threads);
532
533 // Returns true on linux if library has the noexecstack flag set.
534 public native boolean checkLibSpecifiesNoexecstack(String libfilename);
535
536 // Container testing
537 public native boolean isContainerized();
538 public native void printOsInfo();
539
540 // Decoder
541 public native void disableElfSectionCache();
542
543 // Resolved Method Table
544 public native int resolvedMethodRemovedCount();
545
546 // Protection Domain Table
547 public native int protectionDomainRemovedCount();
548 }