1 /*
  2  * Copyright (c) 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 
 25 /**
 26  * @test
 27  * @summary Sanity test of combinations of the diagnostic flags [+-]AOTRecordTraining and [+-]AOTReplayTraining
 28  * @requires vm.cds
 29  * @comment work around JDK-8345635
 30  * @requires !vm.jvmci.enabled
 31  * @requires vm.cds.supports.aot.class.linking
 32  * @requires vm.flagless
 33  * @library /test/lib /test/setup_aot /test/hotspot/jtreg/runtime/cds/appcds/test-classes
 34  * @build AOTProfileFlags JavacBenchApp Hello
 35  * @run driver jdk.test.lib.helpers.ClassFileInstaller -jar app.jar
 36  *                 JavacBenchApp
 37  *                 JavacBenchApp$ClassFile
 38  *                 JavacBenchApp$FileManager
 39  *                 JavacBenchApp$SourceFile
 40  * @run driver jdk.test.lib.helpers.ClassFileInstaller -jar hello.jar Hello
 41  * @run driver AOTProfileFlags
 42  */
 43 
 44 import jdk.test.lib.cds.CDSTestUtils;
 45 import jdk.test.lib.cds.SimpleCDSAppTester;
 46 import jdk.test.lib.helpers.ClassFileInstaller;
 47 import jdk.test.lib.Platform;
 48 import jdk.test.lib.process.OutputAnalyzer;
 49 import jdk.test.lib.process.ProcessTools;
 50 
 51 public class AOTProfileFlags {
 52     public static void testDiagnosticFlags() throws Exception {
 53         printTestCase("Diagnostic Flags");
 54         for (int i = 0; i < 2; i++) {
 55             for (int j = 0; j < 2; j ++) {
 56                 SimpleCDSAppTester.of("AOTProfileFlags" + i + "" + j)
 57                     .addVmArgs("-XX:+UnlockDiagnosticVMOptions",
 58                                "-XX:" + (i == 0 ? "-" : "+") + "AOTRecordTraining",
 59                                "-XX:" + (j == 0 ? "-" : "+") + "AOTReplayTraining")
 60                     .classpath("app.jar")
 61                     .appCommandLine("JavacBenchApp", "10")
 62                     .runAOTWorkflow();
 63             }
 64         }
 65     }
 66     static void trainAndRun(String testName, String trainingFlags, String productionFlags, String errorPattern) throws Exception {
 67         printTestCase("Flags mismatch " + testName);
 68 
 69         String appJar = ClassFileInstaller.getJarPath("hello.jar");
 70         String aotConfigFile = "hello.aotconfig";
 71         String aotCacheFile = "hello.aot";
 72         String helloClass = "Hello";
 73 
 74         ProcessBuilder pb;
 75         OutputAnalyzer out;
 76 
 77         // first make sure we have a valid aotConfigFile with default value of TypeProfileLevel
 78         pb = ProcessTools.createLimitedTestJavaProcessBuilder(
 79             "-Xlog:aot",
 80             "-XX:AOTMode=record",
 81             "-XX:AOTConfiguration=" + aotConfigFile,
 82             "-XX:+UnlockExperimentalVMOptions",
 83             trainingFlags,
 84             "-cp", appJar, helloClass);
 85 
 86         out = CDSTestUtils.executeAndLog(pb, "train");
 87         out.shouldHaveExitValue(0);
 88 
 89         pb = ProcessTools.createLimitedTestJavaProcessBuilder(
 90             "-Xlog:aot",
 91             "-XX:AOTMode=create",
 92             "-XX:AOTConfiguration=" + aotConfigFile,
 93             "-XX:AOTCache=" + aotCacheFile,
 94             "-XX:+UnlockExperimentalVMOptions",
 95             trainingFlags,
 96             "-cp", appJar);
 97 
 98         out = CDSTestUtils.executeAndLog(pb, "assemble");
 99         out.shouldHaveExitValue(0);
100 
101         pb = ProcessTools.createLimitedTestJavaProcessBuilder(
102             "-Xlog:aot",
103             "-XX:AOTCache=" + aotCacheFile,
104             "-XX:+UnlockExperimentalVMOptions",
105             trainingFlags,
106             "-cp", appJar, helloClass);
107 
108         out = CDSTestUtils.executeAndLog(pb, "production_success");
109         out.shouldNotMatch(errorPattern);
110         out.shouldHaveExitValue(0);
111 
112         pb = ProcessTools.createLimitedTestJavaProcessBuilder(
113             "-Xlog:aot",
114             "-XX:AOTCache=" + aotCacheFile,
115             "-XX:+UnlockExperimentalVMOptions",
116             productionFlags,
117             "-cp", appJar, helloClass);
118 
119         out = CDSTestUtils.executeAndLog(pb, "production_failure");
120         out.shouldMatch(errorPattern);
121         out.shouldHaveExitValue(1); // RequireSharedSpaces is on in premain
122     }
123 
124     public static void testFlagsMismatch() throws Exception {
125         String errorPattern = ".*Profile.* setting .* does not equal the current .*Profile.* setting.*";
126         trainAndRun("TypeProfileLevel", "-XX:TypeProfileLevel=222", "-XX:TypeProfileLevel=111", errorPattern);
127         trainAndRun("TypeProfileArgsLimit", "-XX:TypeProfileArgsLimit=2", "-XX:TypeProfileArgsLimit=3", errorPattern);
128         trainAndRun("TypeProfileParamsLimit", "-XX:TypeProfileParmsLimit=2", "-XX:TypeProfileParmsLimit=3", errorPattern);
129         trainAndRun("TypeProfileWidth", "-XX:TypeProfileWidth=2", "-XX:TypeProfileWidth=3", errorPattern);
130         if (Platform.isDebugBuild()) {
131           trainAndRun("ProfileTraps", "-XX:+ProfileTraps", "-XX:-ProfileTraps", errorPattern);
132           trainAndRun("TypeProfileCasts", "-XX:+TypeProfileCasts", "-XX:-TypeProfileCasts", errorPattern);
133         }
134         errorPattern = "SpecTrapLimitExtraEntries setting .* does not equal the current SpecTrapLimitExtraEntries setting";
135         trainAndRun("SpecTrapLimitExtraEntries", "-XX:SpecTrapLimitExtraEntries=2", "-XX:SpecTrapLimitExtraEntries=3", errorPattern);
136     }
137 
138     static int testNum = 0;
139     static void printTestCase(String s) {
140         System.out.println("vvvvvvv TEST CASE " + testNum + ": " + s + " starts here vvvvvvv");
141         testNum++;
142     }
143     public static void main(String... args) throws Exception {
144         testDiagnosticFlags();
145         testFlagsMismatch();
146     }
147 }