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