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