1 /*
2 * Copyright (c) 2016, 2026, 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 requires;
25
26 import java.io.BufferedInputStream;
27 import java.io.FileInputStream;
28 import java.io.IOException;
29 import java.io.InputStream;
30 import java.io.File;
31 import java.nio.charset.Charset;
32 import java.nio.file.Files;
33 import java.nio.file.Path;
34 import java.nio.file.Paths;
35 import java.nio.file.StandardOpenOption;
36 import java.time.Instant;
37 import java.util.ArrayList;
38 import java.util.Collections;
39 import java.util.HashMap;
40 import java.util.List;
41 import java.util.Map;
42 import java.util.Properties;
43 import java.util.Set;
44 import java.util.concurrent.Callable;
45 import java.util.concurrent.TimeUnit;
46 import java.util.function.Predicate;
47 import java.util.function.Supplier;
48 import java.util.regex.Matcher;
49 import java.util.regex.Pattern;
50 import java.util.stream.Stream;
51
52 import jdk.internal.foreign.CABI;
53 import jdk.internal.misc.PreviewFeatures;
54 import jdk.test.whitebox.code.Compiler;
55 import jdk.test.whitebox.cpuinfo.CPUInfo;
56 import jdk.test.whitebox.gc.GC;
57 import jdk.test.whitebox.WhiteBox;
58 import jdk.test.lib.Platform;
59 import jdk.test.lib.Container;
60
61 /**
62 * The Class to be invoked by jtreg prior Test Suite execution to
63 * collect information about VM.
64 * Do not use any APIs that may not be available in all target VMs.
65 * Properties set by this Class will be available in the @requires expressions.
66 */
67 public class VMProps implements Callable<Map<String, String>> {
68 // value known to jtreg as an indicator of error state
69 private static final String ERROR_STATE = "__ERROR__";
70
71 private static final String GC_PREFIX = "-XX:+Use";
72 private static final String GC_SUFFIX = "GC";
73
74 private static final WhiteBox WB = WhiteBox.getWhiteBox();
75
76 private static class SafeMap {
77 private final Map<String, String> map = new HashMap<>();
78
79 public void put(String key, Supplier<String> s) {
80 String value;
81 try {
82 value = s.get();
83 } catch (Throwable t) {
84 System.err.println("failed to get value for " + key);
85 t.printStackTrace(System.err);
86 value = ERROR_STATE + t;
87 }
88 map.put(key, value);
89 }
90 }
91
92 /**
93 * Collects information about VM properties.
94 * This method will be invoked by jtreg.
95 *
96 * @return Map of property-value pairs.
97 */
98 @Override
99 public Map<String, String> call() {
100 log("Entering call()");
101 SafeMap map = new SafeMap();
102 map.put("vm.flavor", this::vmFlavor);
103 map.put("vm.compMode", this::vmCompMode);
104 map.put("vm.bits", this::vmBits);
105 map.put("vm.flightRecorder", this::vmFlightRecorder);
106 map.put("vm.simpleArch", this::vmArch);
107 map.put("vm.debug", this::vmDebug);
108 map.put("vm.jvmci", this::vmJvmci);
109 map.put("vm.jvmci.enabled", this::vmJvmciEnabled);
110 // vm.hasSA is "true" if the VM contains the serviceability agent
111 // and jhsdb.
112 map.put("vm.hasSA", this::vmHasSA);
113 // vm.hasJFR is "true" if JFR is included in the build of the VM and
114 // so tests can be executed.
115 map.put("vm.hasJFR", this::vmHasJFR);
116 map.put("vm.hasDTrace", this::vmHasDTrace);
117 map.put("vm.jvmti", this::vmHasJVMTI);
118 map.put("vm.cpu.features", this::cpuFeatures);
119 map.put("vm.pageSize", this::vmPageSize);
120 // vm.cds is true if the VM is compiled with cds support.
121 map.put("vm.cds", this::vmCDS);
122 map.put("vm.cds.default.archive.available", this::vmCDSDefaultArchiveAvailable);
123 map.put("vm.cds.nocoops.archive.available", this::vmCDSNocoopsArchiveAvailable);
124 map.put("vm.cds.custom.loaders", this::vmCDSForCustomLoaders);
125 map.put("vm.cds.supports.aot.class.linking", this::vmCDSSupportsAOTClassLinking);
126 map.put("vm.cds.supports.aot.code.caching", this::vmCDSSupportsAOTCodeCaching);
127 map.put("vm.cds.write.archived.java.heap", this::vmCDSCanWriteArchivedJavaHeap);
128 map.put("vm.cds.write.mapped.java.heap", this::vmCDSCanWriteMappedArchivedJavaHeap);
129 map.put("vm.cds.write.streamed.java.heap", this::vmCDSCanWriteStreamedArchivedJavaHeap);
130 map.put("vm.continuations", this::vmContinuations);
131 // vm.graal.enabled is true if Graal is used as JIT
132 map.put("vm.graal.enabled", this::isGraalEnabled);
133 // jdk.hasLibgraal is true if the libgraal shared library file is present
134 map.put("jdk.hasLibgraal", this::hasLibgraal);
135 map.put("java.enablePreview", this::isPreviewEnabled);
136 map.put("vm.libgraal.jit", this::isLibgraalJIT);
137 map.put("vm.compiler1.enabled", this::isCompiler1Enabled);
138 map.put("vm.compiler2.enabled", this::isCompiler2Enabled);
139 map.put("container.support", this::containerSupport);
140 map.put("systemd.support", this::systemdSupport);
141 map.put("vm.musl", this::isMusl);
142 map.put("vm.asan", this::isAsanEnabled);
143 map.put("vm.ubsan", this::isUbsanEnabled);
144 map.put("release.implementor", this::implementor);
145 map.put("jdk.containerized", this::jdkContainerized);
146 map.put("vm.flagless", this::isFlagless);
147 map.put("jdk.foreign.linker", this::jdkForeignLinker);
148 map.put("jdk.explodedImage", this::explodedImage);
149 map.put("jlink.packagedModules", this::packagedModules);
150 map.put("jdk.static", this::isStatic);
151 vmGC(map); // vm.gc.X = true/false
152 vmGCforCDS(map); // may set vm.gc
153 vmOptFinalFlags(map);
154 vmOptFinalIntxFlags(map);
155
156 dump(map.map);
157 log("Leaving call()");
158 return map.map;
159 }
160
161 /**
162 * Print a stack trace before returning error state;
163 * Used by the various helper functions which parse information from
164 * VM properties in the case where they don't find an expected property
165 * or a property doesn't conform to an expected format.
166 *
167 * @return {@link #ERROR_STATE}
168 */
169 private String errorWithMessage(String message) {
170 new Exception(message).printStackTrace();
171 return ERROR_STATE + message;
172 }
173
174 /**
175 * @return vm.simpleArch value of "os.simpleArch" property of tested JDK.
176 */
177 protected String vmArch() {
178 String arch = System.getProperty("os.arch");
179 if (arch.equals("x86_64") || arch.equals("amd64")) {
180 return "x64";
181 } else if (arch.contains("86")) {
182 return "x86";
183 } else {
184 return arch;
185 }
186 }
187
188 /**
189 * @return VM type value extracted from the "java.vm.name" property.
190 */
191 protected String vmFlavor() {
192 // E.g. "Java HotSpot(TM) 64-Bit Server VM"
193 String vmName = System.getProperty("java.vm.name");
194 if (vmName == null) {
195 return errorWithMessage("Can't get 'java.vm.name' property");
196 }
197
198 Pattern startP = Pattern.compile(".* (\\S+) VM");
199 Matcher m = startP.matcher(vmName);
200 if (m.matches()) {
201 return m.group(1).toLowerCase();
202 }
203 return errorWithMessage("Can't get VM flavor from 'java.vm.name'");
204 }
205
206 /**
207 * @return VM compilation mode extracted from the "java.vm.info" property.
208 */
209 protected String vmCompMode() {
210 // E.g. "mixed mode"
211 String vmInfo = System.getProperty("java.vm.info");
212 if (vmInfo == null) {
213 return errorWithMessage("Can't get 'java.vm.info' property");
214 }
215 vmInfo = vmInfo.toLowerCase();
216 if (vmInfo.contains("mixed mode")) {
217 return "Xmixed";
218 } else if (vmInfo.contains("compiled mode")) {
219 return "Xcomp";
220 } else if (vmInfo.contains("interpreted mode")) {
221 return "Xint";
222 } else {
223 return errorWithMessage("Can't get compilation mode from 'java.vm.info'");
224 }
225 }
226
227 /**
228 * @return VM bitness, the value of the "sun.arch.data.model" property.
229 */
230 protected String vmBits() {
231 String dataModel = System.getProperty("sun.arch.data.model");
232 if (dataModel != null) {
233 return dataModel;
234 } else {
235 return errorWithMessage("Can't get 'sun.arch.data.model' property");
236 }
237 }
238
239 /**
240 * @return "true" if Flight Recorder is enabled, "false" if is disabled.
241 */
242 protected String vmFlightRecorder() {
243 Boolean isFlightRecorder = WB.getBooleanVMFlag("FlightRecorder");
244 String startFROptions = WB.getStringVMFlag("StartFlightRecording");
245 if (isFlightRecorder != null && isFlightRecorder) {
246 return "true";
247 }
248 if (startFROptions != null && !startFROptions.isEmpty()) {
249 return "true";
250 }
251 return "false";
252 }
253
254 /**
255 * @return debug level value extracted from the "jdk.debug" property.
256 */
257 protected String vmDebug() {
258 String debug = System.getProperty("jdk.debug");
259 if (debug != null) {
260 return "" + debug.contains("debug");
261 } else {
262 return errorWithMessage("Can't get 'jdk.debug' property");
263 }
264 }
265
266 /**
267 * @return true if VM supports JVMCI and false otherwise
268 */
269 protected String vmJvmci() {
270 // builds with jvmci have this flag
271 if (WB.getBooleanVMFlag("EnableJVMCI") == null) {
272 return "false";
273 }
274
275 // Not all GCs have full JVMCI support
276 if (!WB.isJVMCISupportedByGC()) {
277 return "false";
278 }
279
280 // Interpreted mode cannot enable JVMCI
281 if (vmCompMode().equals("Xint")) {
282 return "false";
283 }
284
285 return "true";
286 }
287
288
289 /**
290 * @return true if JVMCI is enabled
291 */
292 protected String vmJvmciEnabled() {
293 // builds with jvmci have this flag
294 if ("false".equals(vmJvmci())) {
295 return "false";
296 }
297
298 return "" + Compiler.isJVMCIEnabled();
299 }
300
301 /**
302 * @return supported CPU features
303 */
304 protected String cpuFeatures() {
305 return CPUInfo.getFeatures().toString();
306 }
307
308 /**
309 * For all existing GC sets vm.gc.X property.
310 * Example vm.gc.G1=true means:
311 * VM supports G1
312 * User either set G1 explicitely (-XX:+UseG1GC) or did not set any GC
313 * G1 can be selected, i.e. it doesn't conflict with other VM flags
314 *
315 * @param map - property-value pairs
316 */
317 protected void vmGC(SafeMap map) {
318 var isJVMCIEnabled = Compiler.isJVMCIEnabled();
319 Predicate<GC> vmGCProperty = (GC gc) -> (gc.isSupported()
320 && (!isJVMCIEnabled || gc.isSupportedByJVMCICompiler())
321 && (gc.isSelected() || GC.isSelectedErgonomically()));
322 for (GC gc: GC.values()) {
323 map.put("vm.gc." + gc.name(), () -> "" + vmGCProperty.test(gc));
324 }
325 }
326
327 /**
328 * "jtreg -vmoptions:-Dtest.cds.runtime.options=..." can be used to specify
329 * the GC type to be used when running with a CDS archive. Set "vm.gc" accordingly,
330 * so that tests that need to explicitly choose the GC type can be excluded
331 * with "@requires vm.gc == null".
332 *
333 * @param map - property-value pairs
334 */
335 protected void vmGCforCDS(SafeMap map) {
336 if (!GC.isSelectedErgonomically()) {
337 // The GC has been explicitly specified on the command line, so
338 // jtreg will set the "vm.gc" property. Let's not interfere with it.
339 return;
340 }
341
342 String jtropts = System.getProperty("test.cds.runtime.options");
343 if (jtropts != null) {
344 for (String opt : jtropts.split(",")) {
345 if (opt.startsWith(GC_PREFIX) && opt.endsWith(GC_SUFFIX)) {
346 String gc = opt.substring(GC_PREFIX.length(), opt.length() - GC_SUFFIX.length());
347 map.put("vm.gc", () -> gc);
348 }
349 }
350 }
351 }
352
353 /**
354 * Selected final flag.
355 *
356 * @param map - property-value pairs
357 * @param flagName - flag name
358 */
359 private void vmOptFinalFlag(SafeMap map, String flagName) {
360 map.put("vm.opt.final." + flagName,
361 () -> String.valueOf(WB.getBooleanVMFlag(flagName)));
362 }
363
364 /**
365 * Selected sets of final flags.
366 *
367 * @param map - property-value pairs
368 */
369 protected void vmOptFinalFlags(SafeMap map) {
370 vmOptFinalFlag(map, "ClassUnloading");
371 vmOptFinalFlag(map, "ClassUnloadingWithConcurrentMark");
372 vmOptFinalFlag(map, "CriticalJNINatives");
373 vmOptFinalFlag(map, "EnableJVMCI");
374 vmOptFinalFlag(map, "EliminateAllocations");
375 vmOptFinalFlag(map, "UnlockExperimentalVMOptions");
376 vmOptFinalFlag(map, "UseAdaptiveSizePolicy");
377 vmOptFinalFlag(map, "UseCompressedOops");
378 vmOptFinalFlag(map, "UseLargePages");
379 vmOptFinalFlag(map, "UseTransparentHugePages");
380 vmOptFinalFlag(map, "UseVectorizedMismatchIntrinsic");
381 }
382
383 /**
384 * Selected final flag of type intx.
385 *
386 * @param map - property-value pairs
387 * @param flagName - flag name
388 */
389 private void vmOptFinalIntxFlag(SafeMap map, String flagName) {
390 map.put("vm.opt.final." + flagName,
391 () -> String.valueOf(WB.getIntxVMFlag(flagName)));
392 }
393
394 /**
395 * Selected sets of final flags of type intx.
396 *
397 * @param map - property-value pairs
398 */
399 protected void vmOptFinalIntxFlags(SafeMap map) {
400 vmOptFinalIntxFlag(map, "MaxVectorSize");
401 }
402
403 /**
404 * @return "true" if VM has a serviceability agent.
405 */
406 protected String vmHasSA() {
407 return "" + Platform.hasSA();
408 }
409
410 /**
411 * @return "true" if the VM is compiled with Java Flight Recorder (JFR)
412 * support.
413 */
414 protected String vmHasJFR() {
415 return "" + WB.isJFRIncluded();
416 }
417
418 /**
419 * @return "true" if the VM is compiled with JVMTI
420 */
421 protected String vmHasJVMTI() {
422 return "" + WB.isJVMTIIncluded();
423 }
424
425 /**
426 * @return "true" if the VM is compiled with DTrace
427 */
428 protected String vmHasDTrace() {
429 return "" + WB.isDTraceIncluded();
430 }
431
432 /**
433 * Check for CDS support.
434 *
435 * @return true if CDS is supported by the VM to be tested.
436 */
437 protected String vmCDS() {
438 boolean noJvmtiAdded = allFlags()
439 .filter(s -> s.startsWith("-agentpath"))
440 .findAny()
441 .isEmpty();
442
443 return "" + (noJvmtiAdded && WB.isCDSIncluded());
444 }
445
446 /**
447 * Check for CDS default archive existence.
448 *
449 * @return true if CDS default archive classes.jsa exists in the JDK to be tested.
450 */
451 protected String vmCDSDefaultArchiveAvailable() {
452 Path archive = Paths.get(System.getProperty("java.home"), "lib", "server", "classes.jsa");
453 return "" + ("true".equals(vmCDS()) && Files.exists(archive));
454 }
455
456 /**
457 * Check for CDS no compressed oops archive existence.
458 *
459 * @return true if CDS archive classes_nocoops.jsa exists in the JDK to be tested.
460 */
461 protected String vmCDSNocoopsArchiveAvailable() {
462 Path archive = Paths.get(System.getProperty("java.home"), "lib", "server", "classes_nocoops.jsa");
463 return "" + ("true".equals(vmCDS()) && Files.exists(archive));
464 }
465
466 /**
467 * Check for CDS support for custom loaders.
468 *
469 * @return true if CDS provides support for customer loader in the VM to be tested.
470 */
471 protected String vmCDSForCustomLoaders() {
472 return "" + ("true".equals(vmCDS()) && Platform.areCustomLoadersSupportedForCDS());
473 }
474
475 /**
476 * @return true if it's possible for "java -Xshare:dump" to write Java heap objects
477 * with the current set of jtreg VM options.
478 */
479 protected String vmCDSCanWriteArchivedJavaHeap() {
480 return "" + ("true".equals(vmCDS()) && WB.canWriteJavaHeapArchive());
481 }
482
483 /**
484 * @return true if it's possible for "java -Xshare:dump" to write Java heap objects
485 * with the current set of jtreg VM options.
486 */
487 protected String vmCDSCanWriteMappedArchivedJavaHeap() {
488 return "" + ("true".equals(vmCDS()) && WB.canWriteMappedJavaHeapArchive());
489 }
490
491 /**
492 * @return true if it's possible for "java -Xshare:dump" to write Java heap objects
493 * with the current set of jtreg VM options.
494 */
495 protected String vmCDSCanWriteStreamedArchivedJavaHeap() {
496 return "" + ("true".equals(vmCDS()) && WB.canWriteStreamedJavaHeapArchive());
497 }
498
499 /**
500 * @return true if this VM can support the -XX:AOTClassLinking option
501 */
502 protected String vmCDSSupportsAOTClassLinking() {
503 // Currently, the VM supports AOTClassLinking as long as it's able to write archived java heap.
504 return vmCDSCanWriteArchivedJavaHeap();
505 }
506
507 /**
508 * @return true if this VM can support the AOT Code Caching
509 */
510 protected String vmCDSSupportsAOTCodeCaching() {
511 if ("true".equals(vmCDSSupportsAOTClassLinking()) &&
512 !"zero".equals(vmFlavor()) &&
513 "false".equals(vmJvmciEnabled()) &&
514 (Platform.isX64() || Platform.isAArch64())) {
515 return "true";
516 } else {
517 return "false";
518 }
519 }
520
521 /**
522 * @return "true" if this VM supports continuations.
523 */
524 protected String vmContinuations() {
525 if (WB.getBooleanVMFlag("VMContinuations")) {
526 return "true";
527 } else {
528 return "false";
529 }
530 }
531
532 /**
533 * @return System page size in bytes.
534 */
535 protected String vmPageSize() {
536 return "" + WB.getVMPageSize();
537 }
538
539 /**
540 * Check if Graal is used as JIT compiler.
541 *
542 * @return true if Graal is used as JIT compiler.
543 */
544 protected String isGraalEnabled() {
545 return "" + Compiler.isGraalEnabled();
546 }
547
548 /**
549 * Check if the libgraal shared library file is present.
550 *
551 * @return true if the libgraal shared library file is present.
552 */
553 protected String hasLibgraal() {
554 return "" + WB.hasLibgraal();
555 }
556
557 /**
558 * Check if libgraal is used as JIT compiler.
559 *
560 * @return true if libgraal is used as JIT compiler.
561 */
562 protected String isLibgraalJIT() {
563 return "" + Compiler.isLibgraalJIT();
564 }
565
566 /**
567 * Check if Compiler1 is present.
568 *
569 * @return true if Compiler1 is used as JIT compiler, either alone or as part of the tiered system.
570 */
571 protected String isCompiler1Enabled() {
572 return "" + Compiler.isC1Enabled();
573 }
574
575 /**
576 * Check if Compiler2 is present.
577 *
578 * @return true if Compiler2 is used as JIT compiler, either alone or as part of the tiered system.
579 */
580 protected String isCompiler2Enabled() {
581 return "" + Compiler.isC2Enabled();
582 }
583
584 protected String isPreviewEnabled() {
585 return "" + PreviewFeatures.isEnabled();
586 }
587 /**
588 * A simple check for container support
589 *
590 * @return true if container is supported in a given environment
591 */
592 protected String containerSupport() {
593 log("Entering containerSupport()");
594
595 boolean isSupported = false;
596 if (Platform.isLinux()) {
597 // currently container testing is only supported for Linux,
598 // on certain platforms
599
600 String arch = System.getProperty("os.arch");
601
602 if (Platform.isX64()) {
603 isSupported = true;
604 } else if (Platform.isAArch64()) {
605 isSupported = true;
606 } else if (Platform.isS390x()) {
607 isSupported = true;
608 } else if (arch.equals("ppc64le")) {
609 isSupported = true;
610 }
611 }
612
613 log("containerSupport(): platform check: isSupported = " + isSupported);
614
615 if (isSupported) {
616 try {
617 isSupported = checkProgramSupport("checkContainerSupport()", Container.ENGINE_COMMAND);
618 } catch (Exception e) {
619 isSupported = false;
620 }
621 }
622
623 log("containerSupport(): returning isSupported = " + isSupported);
624 return "" + isSupported;
625 }
626
627 /**
628 * A simple check for systemd support
629 *
630 * @return true if systemd is supported in a given environment
631 */
632 protected String systemdSupport() {
633 log("Entering systemdSupport()");
634
635 boolean isSupported = Platform.isLinux();
636 if (isSupported) {
637 try {
638 isSupported = checkProgramSupport("checkSystemdSupport()", "systemd-run");
639 } catch (Exception e) {
640 isSupported = false;
641 }
642 }
643
644 log("systemdSupport(): returning isSupported = " + isSupported);
645 return "" + isSupported;
646 }
647
648 // Configures process builder to redirect process stdout and stderr to a file.
649 // Returns file names for stdout and stderr.
650 private Map<String, String> redirectOutputToLogFile(String msg, ProcessBuilder pb, String fileNameBase) {
651 Map<String, String> result = new HashMap<>();
652 String timeStamp = Instant.now().toString().replace(":", "-").replace(".", "-");
653
654 String stdoutFileName = String.format("./%s-stdout--%s.log", fileNameBase, timeStamp);
655 pb.redirectOutput(new File(stdoutFileName));
656 log(msg + ": child process stdout redirected to " + stdoutFileName);
657 result.put("stdout", stdoutFileName);
658
659 String stderrFileName = String.format("./%s-stderr--%s.log", fileNameBase, timeStamp);
660 pb.redirectError(new File(stderrFileName));
661 log(msg + ": child process stderr redirected to " + stderrFileName);
662 result.put("stderr", stderrFileName);
663
664 return result;
665 }
666
667 private void printLogfileContent(Map<String, String> logFileNames) {
668 logFileNames.entrySet().stream()
669 .forEach(entry ->
670 {
671 log("------------- " + entry.getKey());
672 try {
673 Files.lines(Path.of(entry.getValue()))
674 .forEach(line -> log(line));
675 } catch (IOException ie) {
676 log("Exception while reading file: " + ie);
677 }
678 log("-------------");
679 });
680 }
681
682 private boolean checkProgramSupport(String logString, String cmd) throws IOException, InterruptedException {
683 log(logString + ": entering");
684 ProcessBuilder pb = new ProcessBuilder("which", cmd);
685 Map<String, String> logFileNames =
686 redirectOutputToLogFile(logString + ": which " + cmd,
687 pb, "which-cmd");
688 Process p = pb.start();
689 p.waitFor(10, TimeUnit.SECONDS);
690 int exitValue = p.exitValue();
691
692 log(String.format("%s: exitValue = %s, pid = %s", logString, exitValue, p.pid()));
693 if (exitValue != 0) {
694 printLogfileContent(logFileNames);
695 }
696
697 return (exitValue == 0);
698 }
699
700 /**
701 * Checks musl libc.
702 *
703 * @return true if musl libc is used.
704 */
705 protected String isMusl() {
706 return Boolean.toString(WB.getLibcName().contains("musl"));
707 }
708
709 // Sanitizer support
710 protected String isAsanEnabled() {
711 return "" + WB.isAsanEnabled();
712 }
713
714 protected String isUbsanEnabled() {
715 return "" + WB.isUbsanEnabled();
716 }
717
718 private String implementor() {
719 try (InputStream in = new BufferedInputStream(new FileInputStream(
720 System.getProperty("java.home") + "/release"))) {
721 Properties properties = new Properties();
722 properties.load(in);
723 String implementorProperty = properties.getProperty("IMPLEMENTOR");
724 if (implementorProperty != null) {
725 return implementorProperty.replace("\"", "");
726 }
727 return errorWithMessage("Can't get 'IMPLEMENTOR' property from 'release' file");
728 } catch (IOException e) {
729 e.printStackTrace();
730 return errorWithMessage("Failed to read 'release' file " + e);
731 }
732 }
733
734 private String jdkContainerized() {
735 String isEnabled = System.getenv("TEST_JDK_CONTAINERIZED");
736 return "" + "true".equalsIgnoreCase(isEnabled);
737 }
738
739 private String explodedImage() {
740 try {
741 Path jmodFile = Path.of(System.getProperty("java.home"), "jmods", "java.base.jmod");
742 if (Files.exists(jmodFile)) {
743 return Boolean.FALSE.toString();
744 } else {
745 return Boolean.TRUE.toString();
746 }
747 } catch (Throwable t) {
748 t.printStackTrace();
749 return errorWithMessage("Error in explodedImage " + t);
750 }
751 }
752
753 private String packagedModules() {
754 // Some jlink tests require packaged modules being present (jmods).
755 // For a runtime linkable image build packaged modules aren't present
756 try {
757 Path jmodsDir = Path.of(System.getProperty("java.home"), "jmods");
758 if (jmodsDir.toFile().exists()) {
759 return Boolean.TRUE.toString();
760 } else {
761 return Boolean.FALSE.toString();
762 }
763 } catch (Throwable t) {
764 return Boolean.FALSE.toString();
765 }
766 }
767
768 /**
769 * Checks if we are in <i>almost</i> out-of-box configuration, i.e. the flags
770 * which JVM is started with don't affect its behavior "significantly".
771 * {@code TEST_VM_FLAGLESS} enviroment variable can be used to force this
772 * method to return true or false and allow or reject any flags.
773 *
774 * @return true if there are no JVM flags
775 */
776 private String isFlagless() {
777 boolean result = true;
778 String flagless = System.getenv("TEST_VM_FLAGLESS");
779 if (flagless != null) {
780 return "" + "true".equalsIgnoreCase(flagless);
781 }
782
783 List<String> allFlags = allFlags().toList();
784
785 // check -XX flags
786 var ignoredXXFlags = Set.of(
787 // added by run-test framework
788 "MaxRAMPercentage",
789 // added by test environment
790 "CreateCoredumpOnCrash"
791 );
792 result &= allFlags.stream()
793 .filter(s -> s.startsWith("-XX:"))
794 // map to names:
795 // remove -XX:
796 .map(s -> s.substring(4))
797 // remove +/- from bool flags
798 .map(s -> s.charAt(0) == '+' || s.charAt(0) == '-' ? s.substring(1) : s)
799 // remove =.* from others
800 .map(s -> s.contains("=") ? s.substring(0, s.indexOf('=')) : s)
801 // skip known-to-be-there flags
802 .filter(s -> !ignoredXXFlags.contains(s))
803 .findAny()
804 .isEmpty();
805
806 // check -X flags
807 var ignoredXFlags = Set.of(
808 // default, yet still seen to be explicitly set
809 "mixed",
810 // -XmxmNNNm added by run-test framework for non-hotspot tests
811 "mx"
812 );
813 result &= allFlags.stream()
814 .filter(s -> s.startsWith("-X") && !s.startsWith("-XX:"))
815 // map to names:
816 // remove -X
817 .map(s -> s.substring(2))
818 // remove :.* from flags with values
819 .map(s -> s.contains(":") ? s.substring(0, s.indexOf(':')) : s)
820 // remove size like 4G, 768m which might be set for non-hotspot tests
821 .map(s -> s.replaceAll("(\\d+)[mMgGkK]", ""))
822 // skip known-to-be-there flags
823 .filter(s -> !ignoredXFlags.contains(s))
824 .findAny()
825 .isEmpty();
826
827 return "" + result;
828 }
829
830 private Stream<String> allFlags() {
831 return Stream.of((System.getProperty("test.vm.opts", "") + " " + System.getProperty("test.java.opts", "")).trim().split("\\s+"));
832 }
833
834 /*
835 * A string indicating the foreign linker that is currently being used. See jdk.internal.foreign.CABI
836 * for valid values.
837 *
838 * "FALLBACK" and "UNSUPPORTED" are special values. The former indicates the fallback linker is
839 * being used. The latter indicates an unsupported platform.
840 */
841 private String jdkForeignLinker() {
842 return String.valueOf(CABI.current());
843 }
844
845 private String isStatic() {
846 return Boolean.toString(WB.isStatic());
847 }
848
849 /**
850 * Dumps the map to the file if the file name is given as the property.
851 * This functionality could be helpful to know context in the real
852 * execution.
853 *
854 * @param map
855 */
856 protected static void dump(Map<String, String> map) {
857 String dumpFileName = System.getProperty("vmprops.dump");
858 if (dumpFileName == null) {
859 return;
860 }
861 List<String> lines = new ArrayList<>();
862 map.forEach((k, v) -> lines.add(k + ":" + v));
863 Collections.sort(lines);
864 try {
865 Files.write(Paths.get(dumpFileName), lines,
866 StandardOpenOption.APPEND, StandardOpenOption.CREATE);
867 } catch (IOException e) {
868 throw new RuntimeException("Failed to dump properties into '"
869 + dumpFileName + "'", e);
870 }
871 }
872
873 /**
874 * Log diagnostic message.
875 *
876 * @param msg
877 */
878 protected static void log(String msg) {
879 // Always log to a file.
880 logToFile(msg);
881
882 // Also log to stderr; guarded by property to avoid excessive verbosity.
883 // By jtreg design stderr produced here will be visible
884 // in the output of a parent process. Note: stdout should not be used
885 // for logging as jtreg parses that output directly and only echoes it
886 // in the event of a failure.
887 if (Boolean.getBoolean("jtreg.log.vmprops")) {
888 System.err.println("VMProps: " + msg);
889 }
890 }
891
892 /**
893 * Log diagnostic message to a file.
894 *
895 * @param msg
896 */
897 protected static void logToFile(String msg) {
898 String fileName = "./vmprops.log";
899 try {
900 Files.writeString(Paths.get(fileName), msg + "\n", Charset.forName("ISO-8859-1"),
901 StandardOpenOption.APPEND, StandardOpenOption.CREATE);
902 } catch (IOException e) {
903 throw new RuntimeException("Failed to log into '" + fileName + "'", e);
904 }
905 }
906
907 /**
908 * This method is for the testing purpose only.
909 *
910 * @param args
911 */
912 public static void main(String args[]) {
913 Map<String, String> map = new VMProps().call();
914 map.forEach((k, v) -> System.out.println(k + ": '" + v + "'"));
915 }
916 }