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