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, "TieredCompilation");
377 vmOptFinalFlag(map, "UnlockExperimentalVMOptions");
378 vmOptFinalFlag(map, "UseCompressedOops");
379 vmOptFinalFlag(map, "UseLargePages");
380 vmOptFinalFlag(map, "UseVectorizedMismatchIntrinsic");
381 }
382
383 /**
384 * @return "true" if VM has a serviceability agent.
385 */
386 protected String vmHasSA() {
387 return "" + Platform.hasSA();
388 }
389
390 /**
391 * @return "true" if the VM is compiled with Java Flight Recorder (JFR)
392 * support.
393 */
394 protected String vmHasJFR() {
395 return "" + WB.isJFRIncluded();
396 }
397
398 /**
399 * @return "true" if the VM is compiled with JVMTI
400 */
401 protected String vmHasJVMTI() {
402 return "" + WB.isJVMTIIncluded();
403 }
404
405 /**
406 * @return "true" if the VM is compiled with DTrace
407 */
408 protected String vmHasDTrace() {
409 return "" + WB.isDTraceIncluded();
410 }
411
412 /**
413 * @return "true" if compiler in use supports RTM and "false" otherwise.
414 * Note: Lightweight locking does not support RTM (for now).
415 */
416 protected String vmRTMCompiler() {
417 boolean isRTMCompiler = false;
418
419 if (Compiler.isC2Enabled() &&
420 (Platform.isX86() || Platform.isX64() || Platform.isPPC()) &&
421 is_LM_LIGHTWEIGHT().equals("false")) {
422 isRTMCompiler = true;
423 }
424 return "" + isRTMCompiler;
425 }
426
427 /**
428 * @return true if VM runs RTM supported CPU and false otherwise.
429 */
430 protected String vmRTMCPU() {
431 return "" + CPUInfo.hasFeature("rtm");
432 }
433
434 /**
435 * Check for CDS support.
436 *
437 * @return true if CDS is supported by the VM to be tested.
438 */
439 protected String vmCDS() {
440 return "" + WB.isCDSIncluded();
441 }
442
443 /**
444 * Check for CDS support for custom loaders.
445 *
446 * @return true if CDS provides support for customer loader in the VM to be tested.
447 */
448 protected String vmCDSForCustomLoaders() {
449 return "" + ("true".equals(vmCDS()) && Platform.areCustomLoadersSupportedForCDS());
450 }
451
452 /**
453 * @return true if this VM can write Java heap objects into the CDS archive
454 */
455 protected String vmCDSCanWriteArchivedJavaHeap() {
456 return "" + ("true".equals(vmCDS()) && WB.canWriteJavaHeapArchive()
457 && isCDSRuntimeOptionsCompatible());
458 }
459
460 /**
461 * @return true if the VM options specified via the "test.cds.runtime.options"
462 * property is compatible with writing Java heap objects into the CDS archive
463 */
464 protected boolean isCDSRuntimeOptionsCompatible() {
465 String jtropts = System.getProperty("test.cds.runtime.options");
466 if (jtropts == null) {
467 return true;
468 }
469 String CCP_DISABLED = "-XX:-UseCompressedClassPointers";
470 String G1GC_ENABLED = "-XX:+UseG1GC";
471 String PARALLELGC_ENABLED = "-XX:+UseParallelGC";
472 String SERIALGC_ENABLED = "-XX:+UseSerialGC";
473 for (String opt : jtropts.split(",")) {
474 if (opt.equals(CCP_DISABLED)) {
475 return false;
476 }
477 if (opt.startsWith(GC_PREFIX) && opt.endsWith(GC_SUFFIX) &&
478 !opt.equals(G1GC_ENABLED) && !opt.equals(PARALLELGC_ENABLED) && !opt.equals(SERIALGC_ENABLED)) {
479 return false;
480 }
481 }
482 return true;
483 }
484
485 /**
486 * @return "true" if this VM supports continuations.
487 */
488 protected String vmContinuations() {
489 if (WB.getBooleanVMFlag("VMContinuations")) {
490 return "true";
491 } else {
492 return "false";
493 }
494 }
495
496 /**
497 * @return System page size in bytes.
498 */
499 protected String vmPageSize() {
500 return "" + WB.getVMPageSize();
501 }
502
503 /**
504 * @return LockingMode.
505 */
506 protected String vmLockingMode() {
507 return "" + WB.getIntVMFlag("LockingMode");
508 }
509
510 /**
511 * @return "true" if LockingMode == 0 (LM_MONITOR)
512 */
513 protected String is_LM_MONITOR() {
514 return "" + vmLockingMode().equals("0");
515 }
516
517 /**
518 * @return "true" if LockingMode == 1 (LM_LEGACY)
519 */
520 protected String is_LM_LEGACY() {
521 return "" + vmLockingMode().equals("1");
522 }
523
524 /**
525 * @return "true" if LockingMode == 2 (LM_LIGHTWEIGHT)
526 */
527 protected String is_LM_LIGHTWEIGHT() {
528 return "" + vmLockingMode().equals("2");
529 }
530
531 /**
532 * Check if Graal is used as JIT compiler.
533 *
534 * @return true if Graal is used as JIT compiler.
535 */
536 protected String isGraalEnabled() {
537 return "" + Compiler.isGraalEnabled();
538 }
539
540 /**
541 * Check if the libgraal shared library file is present.
542 *
543 * @return true if the libgraal shared library file is present.
544 */
545 protected String hasLibgraal() {
546 return "" + WB.hasLibgraal();
547 }
548
549 /**
550 * Check if libgraal is used as JIT compiler.
551 *
552 * @return true if libgraal is used as JIT compiler.
553 */
554 protected String isLibgraalJIT() {
555 return "" + Compiler.isLibgraalJIT();
556 }
557
558 /**
559 * Check if Compiler1 is present.
560 *
561 * @return true if Compiler1 is used as JIT compiler, either alone or as part of the tiered system.
562 */
563 protected String isCompiler1Enabled() {
564 return "" + Compiler.isC1Enabled();
565 }
566
567 /**
568 * Check if Compiler2 is present.
569 *
570 * @return true if Compiler2 is used as JIT compiler, either alone or as part of the tiered system.
571 */
572 protected String isCompiler2Enabled() {
573 return "" + Compiler.isC2Enabled();
574 }
575
576 /**
577 * A simple check for container support
578 *
579 * @return true if container is supported in a given environment
580 */
581 protected String containerSupport() {
582 log("Entering containerSupport()");
583
584 boolean isSupported = false;
585 if (Platform.isLinux()) {
586 // currently container testing is only supported for Linux,
587 // on certain platforms
588
589 String arch = System.getProperty("os.arch");
590
591 if (Platform.isX64()) {
592 isSupported = true;
593 } else if (Platform.isAArch64()) {
594 isSupported = true;
595 } else if (Platform.isS390x()) {
596 isSupported = true;
597 } else if (arch.equals("ppc64le")) {
598 isSupported = true;
599 }
600 }
601
602 log("containerSupport(): platform check: isSupported = " + isSupported);
603
604 if (isSupported) {
605 try {
606 isSupported = checkProgramSupport("checkContainerSupport()", Container.ENGINE_COMMAND);
607 } catch (Exception e) {
608 isSupported = false;
609 }
610 }
611
612 log("containerSupport(): returning isSupported = " + isSupported);
613 return "" + isSupported;
614 }
615
616 /**
617 * A simple check for systemd support
618 *
619 * @return true if systemd is supported in a given environment
620 */
621 protected String systemdSupport() {
622 log("Entering systemdSupport()");
623
624 boolean isSupported = Platform.isLinux();
625 if (isSupported) {
626 try {
627 isSupported = checkProgramSupport("checkSystemdSupport()", "systemd-run");
628 } catch (Exception e) {
629 isSupported = false;
630 }
631 }
632
633 log("systemdSupport(): returning isSupported = " + isSupported);
634 return "" + isSupported;
635 }
636
637 // Configures process builder to redirect process stdout and stderr to a file.
638 // Returns file names for stdout and stderr.
639 private Map<String, String> redirectOutputToLogFile(String msg, ProcessBuilder pb, String fileNameBase) {
640 Map<String, String> result = new HashMap<>();
641 String timeStamp = Instant.now().toString().replace(":", "-").replace(".", "-");
642
643 String stdoutFileName = String.format("./%s-stdout--%s.log", fileNameBase, timeStamp);
644 pb.redirectOutput(new File(stdoutFileName));
645 log(msg + ": child process stdout redirected to " + stdoutFileName);
646 result.put("stdout", stdoutFileName);
647
648 String stderrFileName = String.format("./%s-stderr--%s.log", fileNameBase, timeStamp);
649 pb.redirectError(new File(stderrFileName));
650 log(msg + ": child process stderr redirected to " + stderrFileName);
651 result.put("stderr", stderrFileName);
652
653 return result;
654 }
655
656 private void printLogfileContent(Map<String, String> logFileNames) {
657 logFileNames.entrySet().stream()
658 .forEach(entry ->
659 {
660 log("------------- " + entry.getKey());
661 try {
662 Files.lines(Path.of(entry.getValue()))
663 .forEach(line -> log(line));
664 } catch (IOException ie) {
665 log("Exception while reading file: " + ie);
666 }
667 log("-------------");
668 });
669 }
670
671 private boolean checkProgramSupport(String logString, String cmd) throws IOException, InterruptedException {
672 log(logString + ": entering");
673 ProcessBuilder pb = new ProcessBuilder("which", cmd);
674 Map<String, String> logFileNames =
675 redirectOutputToLogFile(logString + ": which " + cmd,
676 pb, "which-cmd");
677 Process p = pb.start();
678 p.waitFor(10, TimeUnit.SECONDS);
679 int exitValue = p.exitValue();
680
681 log(String.format("%s: exitValue = %s, pid = %s", logString, exitValue, p.pid()));
682 if (exitValue != 0) {
683 printLogfileContent(logFileNames);
684 }
685
686 return (exitValue == 0);
687 }
688
689 /**
690 * Checks musl libc.
691 *
692 * @return true if musl libc is used.
693 */
694 protected String isMusl() {
695 return Boolean.toString(WB.getLibcName().contains("musl"));
696 }
697
698 private String implementor() {
699 try (InputStream in = new BufferedInputStream(new FileInputStream(
700 System.getProperty("java.home") + "/release"))) {
701 Properties properties = new Properties();
702 properties.load(in);
703 String implementorProperty = properties.getProperty("IMPLEMENTOR");
704 if (implementorProperty != null) {
705 return implementorProperty.replace("\"", "");
706 }
707 return errorWithMessage("Can't get 'IMPLEMENTOR' property from 'release' file");
708 } catch (IOException e) {
709 e.printStackTrace();
710 return errorWithMessage("Failed to read 'release' file " + e);
711 }
712 }
713
714 private String jdkContainerized() {
715 String isEnabled = System.getenv("TEST_JDK_CONTAINERIZED");
716 return "" + "true".equalsIgnoreCase(isEnabled);
717 }
718
719 /**
720 * Checks if we are in <i>almost</i> out-of-box configuration, i.e. the flags
721 * which JVM is started with don't affect its behavior "significantly".
722 * {@code TEST_VM_FLAGLESS} enviroment variable can be used to force this
723 * method to return true or false and allow or reject any flags.
724 *
725 * @return true if there are no JVM flags
726 */
727 private String isFlagless() {
728 boolean result = true;
729 String flagless = System.getenv("TEST_VM_FLAGLESS");
730 if (flagless != null) {
731 return "" + "true".equalsIgnoreCase(flagless);
732 }
733
734 List<String> allFlags = allFlags().toList();
735
736 // check -XX flags
737 var ignoredXXFlags = Set.of(
738 // added by run-test framework
739 "MaxRAMPercentage",
740 // added by test environment
741 "CreateCoredumpOnCrash"
742 );
743 result &= allFlags.stream()
744 .filter(s -> s.startsWith("-XX:"))
745 // map to names:
746 // remove -XX:
747 .map(s -> s.substring(4))
748 // remove +/- from bool flags
749 .map(s -> s.charAt(0) == '+' || s.charAt(0) == '-' ? s.substring(1) : s)
750 // remove =.* from others
751 .map(s -> s.contains("=") ? s.substring(0, s.indexOf('=')) : s)
752 // skip known-to-be-there flags
753 .filter(s -> !ignoredXXFlags.contains(s))
754 .findAny()
755 .isEmpty();
756
757 // check -X flags
758 var ignoredXFlags = Set.of(
759 // default, yet still seen to be explicitly set
760 "mixed",
761 // -XmxmNNNm added by run-test framework for non-hotspot tests
762 "mx"
763 );
764 result &= allFlags.stream()
765 .filter(s -> s.startsWith("-X") && !s.startsWith("-XX:"))
766 // map to names:
767 // remove -X
768 .map(s -> s.substring(2))
769 // remove :.* from flags with values
770 .map(s -> s.contains(":") ? s.substring(0, s.indexOf(':')) : s)
771 // remove size like 4G, 768m which might be set for non-hotspot tests
772 .map(s -> s.replaceAll("(\\d+)[mMgGkK]", ""))
773 // skip known-to-be-there flags
774 .filter(s -> !ignoredXFlags.contains(s))
775 .findAny()
776 .isEmpty();
777
778 return "" + result;
779 }
780
781 private Stream<String> allFlags() {
782 return Stream.of((System.getProperty("test.vm.opts", "") + " " + System.getProperty("test.java.opts", "")).trim().split("\\s+"));
783 }
784
785 /*
786 * A string indicating the foreign linker that is currently being used. See jdk.internal.foreign.CABI
787 * for valid values.
788 *
789 * "FALLBACK" and "UNSUPPORTED" are special values. The former indicates the fallback linker is
790 * being used. The latter indicates an unsupported platform.
791 */
792 private String jdkForeignLinker() {
793 return String.valueOf(CABI.current());
794 }
795
796 /**
797 * Dumps the map to the file if the file name is given as the property.
798 * This functionality could be helpful to know context in the real
799 * execution.
800 *
801 * @param map
802 */
803 protected static void dump(Map<String, String> map) {
804 String dumpFileName = System.getProperty("vmprops.dump");
805 if (dumpFileName == null) {
806 return;
807 }
808 List<String> lines = new ArrayList<>();
809 map.forEach((k, v) -> lines.add(k + ":" + v));
810 Collections.sort(lines);
811 try {
812 Files.write(Paths.get(dumpFileName), lines,
813 StandardOpenOption.APPEND, StandardOpenOption.CREATE);
814 } catch (IOException e) {
815 throw new RuntimeException("Failed to dump properties into '"
816 + dumpFileName + "'", e);
817 }
818 }
819
820 /**
821 * Log diagnostic message.
822 *
823 * @param msg
824 */
825 protected static void log(String msg) {
826 // Always log to a file.
827 logToFile(msg);
828
829 // Also log to stderr; guarded by property to avoid excessive verbosity.
830 // By jtreg design stderr produced here will be visible
831 // in the output of a parent process. Note: stdout should not be used
832 // for logging as jtreg parses that output directly and only echoes it
833 // in the event of a failure.
834 if (Boolean.getBoolean("jtreg.log.vmprops")) {
835 System.err.println("VMProps: " + msg);
836 }
837 }
838
839 /**
840 * Log diagnostic message to a file.
841 *
842 * @param msg
843 */
844 protected static void logToFile(String msg) {
845 String fileName = "./vmprops.log";
846 try {
847 Files.writeString(Paths.get(fileName), msg + "\n", Charset.forName("ISO-8859-1"),
848 StandardOpenOption.APPEND, StandardOpenOption.CREATE);
849 } catch (IOException e) {
850 throw new RuntimeException("Failed to log into '" + fileName + "'", e);
851 }
852 }
853
854 /**
855 * This method is for the testing purpose only.
856 *
857 * @param args
858 */
859 public static void main(String args[]) {
860 Map<String, String> map = new VMProps().call();
861 map.forEach((k, v) -> System.out.println(k + ": '" + v + "'"));
862 }
863 }