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