1 /* 2 * Copyright (c) 2021, 2022, 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 compiler.lib.ir_framework.test; 25 26 import compiler.lib.ir_framework.*; 27 import compiler.lib.ir_framework.Compiler; 28 import compiler.lib.ir_framework.shared.*; 29 import jdk.test.lib.Platform; 30 import jdk.test.lib.Utils; 31 import jdk.test.whitebox.WhiteBox; 32 33 import java.io.PrintWriter; 34 import java.io.StringWriter; 35 import java.lang.annotation.Annotation; 36 import java.lang.reflect.*; 37 import java.util.*; 38 import java.util.stream.Collectors; 39 import java.util.stream.Stream; 40 41 /** 42 * This class' main method is called from {@link TestFramework} and represents the so-called "test VM". The class is 43 * the heart of the framework and is responsible for executing all the specified tests in the test class. It uses the 44 * Whitebox API and reflection to achieve this task. 45 */ 46 public class TestVM { 47 private static final WhiteBox WHITE_BOX; 48 49 static { 50 try { 51 WHITE_BOX = WhiteBox.getWhiteBox(); 52 } catch (UnsatisfiedLinkError e) { 53 System.err.println(System.lineSeparator() + """ 54 ########################################################## 55 - Did you call a test-related interface method from 56 TestFramework in main() of your test? Make sure to 57 only call setup/run methods and no checks or 58 assertions from main() of your test! 59 - Are you rerunning the test VM (TestVM class) 60 directly after a JTreg run? Make sure to start it 61 from within JTwork/scratch and with the flag 62 -DReproduce=true! 63 ########################################################## 64 """); 65 throw e; 66 } 67 } 68 69 /** 70 * The default number of warm-up iterations used to warm up a {@link Test} annotated test method. 71 * Use {@code -DWarmup=XY} to specify a different default value. An individual warm-up can also be 72 * set by specifying a {@link Warmup} iteration for a test. 73 */ 74 public static final int WARMUP_ITERATIONS = Integer.parseInt(System.getProperty("Warmup", "2000")); 75 76 private static final boolean TIERED_COMPILATION = (Boolean)WHITE_BOX.getVMFlag("TieredCompilation"); 77 private static final CompLevel TIERED_COMPILATION_STOP_AT_LEVEL; 78 private static final boolean CLIENT_VM = Platform.isClient(); 79 80 static { 81 CompLevel level = CompLevel.forValue(((Long)WHITE_BOX.getVMFlag("TieredStopAtLevel")).intValue()); 82 if (CLIENT_VM && level == CompLevel.C2) { 83 // No C2 available, use C1 level without profiling. 84 level = CompLevel.C1_SIMPLE; 85 } 86 TIERED_COMPILATION_STOP_AT_LEVEL = level; 87 } 88 public static final boolean TEST_C1 = (TIERED_COMPILATION && TIERED_COMPILATION_STOP_AT_LEVEL.getValue() < CompLevel.C2.getValue()) || CLIENT_VM; 89 90 static final boolean XCOMP = Platform.isComp(); 91 static final boolean VERBOSE = Boolean.getBoolean("Verbose"); 92 private static final boolean PRINT_TIMES = Boolean.getBoolean("PrintTimes"); 93 public static final boolean USE_COMPILER = WHITE_BOX.getBooleanVMFlag("UseCompiler"); 94 static final boolean EXCLUDE_RANDOM = Boolean.getBoolean("ExcludeRandom"); 95 private static final String TESTLIST = System.getProperty("Test", ""); 96 private static final String EXCLUDELIST = System.getProperty("Exclude", ""); 97 private static final boolean DUMP_REPLAY = Boolean.getBoolean("DumpReplay"); 98 private static final boolean GC_AFTER = Boolean.getBoolean("GCAfter"); 99 private static final boolean SHUFFLE_TESTS = Boolean.parseBoolean(System.getProperty("ShuffleTests", "true")); 100 // Use separate flag as VERIFY_IR could have been set by user but due to other flags it was disabled by flag VM. 101 private static final boolean PRINT_VALID_IR_RULES = Boolean.getBoolean("ShouldDoIRVerification"); 102 protected static final long PER_METHOD_TRAP_LIMIT = (Long)WHITE_BOX.getVMFlag("PerMethodTrapLimit"); 103 protected static final boolean PROFILE_INTERPRETER = (Boolean)WHITE_BOX.getVMFlag("ProfileInterpreter"); 104 private static final boolean FLIP_C1_C2 = Boolean.getBoolean("FlipC1C2"); 105 private static final boolean IGNORE_COMPILER_CONTROLS = Boolean.getBoolean("IgnoreCompilerControls"); 106 107 private final HashMap<Method, DeclaredTest> declaredTests = new HashMap<>(); 108 private final List<AbstractTest> allTests = new ArrayList<>(); 109 private final HashMap<String, Method> testMethodMap = new HashMap<>(); 110 private final List<String> excludeList; 111 private final List<String> testList; 112 private Set<Class<?>> helperClasses = null; // Helper classes that contain framework annotations to be processed. 113 private final IREncodingPrinter irMatchRulePrinter; 114 private final Class<?> testClass; 115 private final Map<Executable, CompLevel> forceCompileMap = new HashMap<>(); 116 117 private TestVM(Class<?> testClass) { 118 TestRun.check(testClass != null, "Test class cannot be null"); 119 this.testClass = testClass; 120 this.testList = createTestFilterList(TESTLIST, testClass); 121 this.excludeList = createTestFilterList(EXCLUDELIST, testClass); 122 123 if (PRINT_VALID_IR_RULES) { 124 irMatchRulePrinter = new IREncodingPrinter(); 125 } else { 126 irMatchRulePrinter = null; 127 } 128 } 129 130 /** 131 * Parse "test1,test2,test3" into a list. 132 */ 133 private static List<String> createTestFilterList(String list, Class<?> testClass) { 134 List<String> filterList = null; 135 if (!list.isEmpty()) { 136 String classPrefix = testClass.getSimpleName() + "."; 137 filterList = new ArrayList<>(Arrays.asList(list.split(","))); 138 for (int i = filterList.size() - 1; i >= 0; i--) { 139 String test = filterList.get(i); 140 if (test.indexOf(".") > 0) { 141 if (test.startsWith(classPrefix)) { 142 test = test.substring(classPrefix.length()); 143 filterList.set(i, test); 144 } else { 145 filterList.remove(i); 146 } 147 } 148 } 149 } 150 return filterList; 151 } 152 153 /** 154 * Main entry point of the test VM. 155 */ 156 public static void main(String[] args) { 157 try { 158 String testClassName = args[0]; 159 System.out.println("TestVM main() called - about to run tests in class " + testClassName); 160 Class<?> testClass = getClassObject(testClassName, "test"); 161 162 TestVM framework = new TestVM(testClass); 163 framework.addHelperClasses(args); 164 framework.start(); 165 } finally { 166 TestFrameworkSocket.closeClientSocket(); 167 } 168 } 169 170 protected static Class<?> getClassObject(String className, String classType) { 171 try { 172 return Class.forName(className); 173 } catch (Exception e) { 174 throw new TestRunException("Could not find " + classType + " class", e); 175 } 176 } 177 178 /** 179 * Set up all helper classes and verify they are specified correctly. 180 */ 181 private void addHelperClasses(String[] args) { 182 Class<?>[] helperClassesList = getHelperClasses(args); 183 if (helperClassesList != null) { 184 TestRun.check(Arrays.stream(helperClassesList).noneMatch(Objects::isNull), "A Helper class cannot be null"); 185 this.helperClasses = new HashSet<>(); 186 187 for (Class<?> helperClass : helperClassesList) { 188 if (Arrays.stream(testClass.getDeclaredClasses()).anyMatch(c -> c == helperClass)) { 189 // Nested class of test class is automatically treated as helper class 190 TestFormat.failNoThrow("Nested " + helperClass + " inside test " + testClass + " is implicitly" 191 + " treated as helper class and does not need to be specified as such."); 192 continue; 193 } 194 TestRun.check(!this.helperClasses.contains(helperClass), "Cannot add the same class twice: " + helperClass); 195 this.helperClasses.add(helperClass); 196 } 197 } 198 } 199 200 private static Class<?>[] getHelperClasses(String[] args) { 201 if (args.length == 1) { 202 return null; 203 } 204 Class<?>[] helperClasses = new Class<?>[args.length - 1]; // First argument is test class 205 for (int i = 1; i < args.length; i++) { 206 String helperClassName = args[i]; 207 helperClasses[i - 1] = getClassObject(helperClassName, "helper"); 208 } 209 return helperClasses; 210 } 211 212 private void checkHelperClass(Class<?> clazz) { 213 checkAnnotationsInClass(clazz, "helper"); 214 for (Class<?> c : clazz.getDeclaredClasses()) { 215 checkAnnotationsInClass(c, "nested (and helper)"); 216 } 217 } 218 219 private void checkAnnotationsInClass(Class<?> c, String clazzType) { 220 Method[] methods = c.getDeclaredMethods(); 221 for (Method m : methods) { 222 TestFormat.checkNoThrow(getAnnotation(m, Test.class) == null, 223 "Cannot use @Test annotation in " + clazzType + " " + c + " at " + m); 224 TestFormat.checkNoThrow(getAnnotation(m, Run.class) == null, 225 "Cannot use @Run annotation in " + clazzType + " " + c + " at " + m); 226 TestFormat.checkNoThrow(getAnnotation(m, Check.class) == null, 227 "Cannot use @Check annotation in " + clazzType + " " + c + " at " + m); 228 } 229 } 230 231 /** 232 * Only called by internal tests testing the framework itself. Accessed by reflection. Not exposed to normal users. 233 */ 234 private static void runTestsOnSameVM(Class<?> testClass) { 235 if (testClass == null) { 236 StackWalker walker = StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE); 237 testClass = walker.getCallerClass(); 238 } 239 TestVM framework = new TestVM(testClass); 240 framework.start(); 241 } 242 243 /** 244 * Once everything is initialized and set up, start collecting tests and executing them afterwards. 245 */ 246 private void start() { 247 setupTests(); 248 checkForcedCompilationsCompleted(); 249 runTests(); 250 } 251 252 private void setupTests() { 253 for (Class<?> clazz : testClass.getDeclaredClasses()) { 254 checkAnnotationsInClass(clazz, "inner"); 255 } 256 if (DUMP_REPLAY) { 257 addReplay(); 258 } 259 // Make sure to first setup test methods and make them non-inlineable and only then process compile commands. 260 setupDeclaredTests(); 261 processControlAnnotations(testClass); 262 processHelperClasses(); 263 setupCheckedAndCustomRunTests(); 264 265 // All remaining tests are simple base tests without check or specific way to run them. 266 addBaseTests(); 267 if (PRINT_VALID_IR_RULES) { 268 irMatchRulePrinter.emit(); 269 VMInfoPrinter.emit(); 270 } 271 TestFormat.throwIfAnyFailures(); 272 declaredTests.clear(); 273 testMethodMap.clear(); 274 } 275 276 private void addBaseTests() { 277 declaredTests.forEach((m, test) -> { 278 if (test.getAttachedMethod() == null) { 279 try { 280 Arguments argumentsAnno = getAnnotation(m, Arguments.class); 281 TestFormat.check(argumentsAnno != null || m.getParameterCount() == 0, "Missing @Arguments annotation to define arguments of " + m); 282 BaseTest baseTest = new BaseTest(test, shouldExcludeTest(m.getName())); 283 allTests.add(baseTest); 284 if (PRINT_VALID_IR_RULES) { 285 irMatchRulePrinter.emitRuleEncoding(m, baseTest.isSkipped()); 286 } 287 } catch (TestFormatException e) { 288 // Failure logged. Continue and report later. 289 } 290 } 291 }); 292 } 293 294 /** 295 * Check if user wants to exclude this test by checking the -DTest and -DExclude lists. 296 */ 297 private boolean shouldExcludeTest(String testName) { 298 boolean hasTestList = testList != null; 299 boolean hasExcludeList = excludeList != null; 300 if (hasTestList) { 301 return !testList.contains(testName) || (hasExcludeList && excludeList.contains(testName)); 302 } else if (hasExcludeList) { 303 return excludeList.contains(testName); 304 } 305 return false; 306 } 307 308 /** 309 * Generate replay compilation files. 310 */ 311 private void addReplay() { 312 String directive = "[{ match: \"*.*\", DumpReplay: true }]"; 313 TestFramework.check(WHITE_BOX.addCompilerDirective(directive) == 1, "Failed to add DUMP_REPLAY directive"); 314 } 315 316 private void processControlAnnotations(Class<?> clazz) { 317 if (IGNORE_COMPILER_CONTROLS) { 318 return; 319 } 320 // Also apply compile commands to all inner classes of 'clazz'. 321 ArrayList<Class<?>> classes = new ArrayList<>(Arrays.asList(clazz.getDeclaredClasses())); 322 classes.add(clazz); 323 for (Class<?> c : classes) { 324 applyClassAnnotations(c); 325 List<Executable> executables = new ArrayList<>(Arrays.asList(c.getDeclaredMethods())); 326 Collections.addAll(executables, c.getDeclaredConstructors()); 327 for (Executable ex : executables) { 328 checkClassAnnotations(ex); 329 try { 330 applyIndependentCompilationCommands(ex); 331 } catch (TestFormatException e) { 332 // Failure logged. Continue and report later. 333 } 334 } 335 336 // Only force compilation now because above annotations affect inlining 337 for (Executable ex : executables) { 338 try { 339 applyForceCompileCommand(ex); 340 } catch (TestFormatException e) { 341 // Failure logged. Continue and report later. 342 } 343 } 344 } 345 } 346 347 private void applyClassAnnotations(Class<?> c) { 348 ForceCompileClassInitializer anno = getAnnotation(c, ForceCompileClassInitializer.class); 349 if (anno == null) { 350 return; 351 } 352 353 // Compile class initializer 354 CompLevel level = anno.value(); 355 if (level == CompLevel.SKIP || level == CompLevel.WAIT_FOR_COMPILATION) { 356 TestFormat.failNoThrow("Cannot define compilation level SKIP or WAIT_FOR_COMPILATION in " + 357 "@ForceCompileClassInitializer at " + c); 358 return; 359 } 360 level = restrictCompLevel(anno.value()); 361 if (level != CompLevel.SKIP) { 362 // Make sure class is initialized to avoid compilation bailout of <clinit> 363 getClassObject(c.getName(), "nested"); // calls Class.forName() to initialize 'c' 364 TestFormat.checkNoThrow(WHITE_BOX.enqueueInitializerForCompilation(c, level.getValue()), 365 "Failed to enqueue <clinit> of " + c + " for compilation. Did you specify " 366 + "@ForceCompileClassInitializer without providing a static class initialization? " 367 + "Make sure to provide any form of static initialization or remove the annotation. " 368 + "For debugging purposes, -DIgnoreCompilerControls=true can be used to temporarly " 369 + "ignore @ForceCompileClassInitializer annotations."); 370 } 371 } 372 373 private void checkClassAnnotations(Executable ex) { 374 TestFormat.checkNoThrow(getAnnotation(ex, ForceCompileClassInitializer.class) == null, 375 "@ForceCompileClassInitializer only allowed at classes but not at method " + ex); 376 } 377 378 /** 379 * Exclude a method from compilation with a compiler randomly. Return the compiler for which the method was made 380 * not compilable. 381 */ 382 public static Compiler excludeRandomly(Executable ex) { 383 Compiler compiler = switch (Utils.getRandomInstance().nextInt() % 3) { 384 case 1 -> Compiler.C1; 385 case 2 -> Compiler.C2; 386 default -> Compiler.ANY; 387 }; 388 WHITE_BOX.makeMethodNotCompilable(ex, compiler.getValue(), false); 389 WHITE_BOX.makeMethodNotCompilable(ex, compiler.getValue(), true); 390 System.out.println("Excluding from " + compiler.name() + " compilation: " + ex); 391 return compiler; 392 } 393 394 private void applyIndependentCompilationCommands(Executable ex) { 395 ForceInline forceInlineAnno = getAnnotation(ex, ForceInline.class); 396 DontInline dontInlineAnno = getAnnotation(ex, DontInline.class); 397 ForceCompile forceCompileAnno = getAnnotation(ex, ForceCompile.class); 398 DontCompile dontCompileAnno = getAnnotation(ex, DontCompile.class); 399 checkCompilationCommandAnnotations(ex, forceInlineAnno, dontInlineAnno, forceCompileAnno, dontCompileAnno); 400 // First handle inline annotations 401 if (dontInlineAnno != null) { 402 WHITE_BOX.testSetDontInlineMethod(ex, true); 403 } else if (forceInlineAnno != null) { 404 WHITE_BOX.testSetForceInlineMethod(ex, true); 405 } 406 if (dontCompileAnno != null) { 407 dontCompileWithCompiler(ex, dontCompileAnno.value()); 408 } 409 if (EXCLUDE_RANDOM && getAnnotation(ex, Test.class) == null && forceCompileAnno == null && dontCompileAnno == null) { 410 // Randomly exclude helper methods from compilation 411 if (Utils.getRandomInstance().nextBoolean()) { 412 excludeRandomly(ex); 413 } 414 } 415 } 416 417 private void checkCompilationCommandAnnotations(Executable ex, ForceInline forceInlineAnno, DontInline dontInlineAnno, ForceCompile forceCompileAnno, DontCompile dontCompileAnno) { 418 Test testAnno = getAnnotation(ex, Test.class); 419 Run runAnno = getAnnotation(ex, Run.class); 420 Check checkAnno = getAnnotation(ex, Check.class); 421 TestFormat.check((testAnno == null && runAnno == null && checkAnno == null) || Stream.of(forceCompileAnno, dontCompileAnno, forceInlineAnno, dontInlineAnno).noneMatch(Objects::nonNull), 422 "Cannot use explicit compile command annotations (@ForceInline, @DontInline, " + 423 "@ForceCompile or @DontCompile) together with @Test, @Check or @Run: " + ex + ". Use compLevel in @Test for fine tuning."); 424 if (Stream.of(forceInlineAnno, dontCompileAnno, dontInlineAnno).filter(Objects::nonNull).count() > 1) { 425 // Failure 426 TestFormat.check(dontCompileAnno == null || dontInlineAnno == null, 427 "@DontInline is implicitely done with @DontCompile annotation at " + ex); 428 TestFormat.fail("Cannot mix @ForceInline, @DontInline and @DontCompile at the same time at " + ex); 429 } 430 TestFormat.check(forceInlineAnno == null || dontInlineAnno == null, "Cannot have @ForceInline and @DontInline at the same time at " + ex); 431 if (forceCompileAnno != null && dontCompileAnno != null) { 432 CompLevel forceCompileLevel = forceCompileAnno.value(); 433 Compiler dontCompileCompiler = dontCompileAnno.value(); 434 TestFormat.check(dontCompileCompiler != Compiler.ANY, 435 "Cannot have @DontCompile(Compiler.ANY) and @ForceCompile at the same time at " + ex); 436 TestFormat.check(forceCompileLevel != CompLevel.ANY, 437 "Cannot have @ForceCompile(CompLevel.ANY) and @DontCompile at the same time at " + ex); 438 TestFormat.check(forceCompileLevel.isNotCompilationLevelOfCompiler(dontCompileCompiler), 439 "Overlapping compilation level and compiler with @ForceCompile and @DontCompile at " + ex); 440 } 441 } 442 443 /** 444 * Exlude the method from compilation and make sure it is not inlined. 445 */ 446 private void dontCompileAndDontInlineMethod(Method m) { 447 if (!IGNORE_COMPILER_CONTROLS) { 448 WHITE_BOX.makeMethodNotCompilable(m, CompLevel.ANY.getValue(), true); 449 WHITE_BOX.makeMethodNotCompilable(m, CompLevel.ANY.getValue(), false); 450 WHITE_BOX.testSetDontInlineMethod(m, true); 451 } 452 } 453 454 private void dontCompileWithCompiler(Executable ex, Compiler compiler) { 455 if (VERBOSE) { 456 System.out.println("dontCompileWithCompiler " + ex + " , compiler = " + compiler.name()); 457 } 458 WHITE_BOX.makeMethodNotCompilable(ex, compiler.getValue(), true); 459 WHITE_BOX.makeMethodNotCompilable(ex, compiler.getValue(), false); 460 if (compiler == Compiler.ANY) { 461 WHITE_BOX.testSetDontInlineMethod(ex, true); 462 } 463 } 464 465 private void applyForceCompileCommand(Executable ex) { 466 ForceCompile forceCompileAnno = getAnnotation(ex, ForceCompile.class); 467 if (forceCompileAnno != null) { 468 CompLevel compLevel = forceCompileAnno.value(); 469 TestFormat.check(compLevel != CompLevel.SKIP && compLevel != CompLevel.WAIT_FOR_COMPILATION, 470 "Cannot define compilation level SKIP or WAIT_FOR_COMPILATION in @ForceCompile at " + ex); 471 compLevel = restrictCompLevel(forceCompileAnno.value()); 472 if (FLIP_C1_C2) { 473 compLevel = compLevel.flipCompLevel(); 474 compLevel = restrictCompLevel(compLevel.flipCompLevel()); 475 } 476 if (EXCLUDE_RANDOM) { 477 compLevel = compLevel.excludeCompilationRandomly(ex); 478 } 479 if (compLevel != CompLevel.SKIP) { 480 enqueueForCompilation(ex, compLevel); 481 forceCompileMap.put(ex, compLevel); 482 } 483 } 484 } 485 486 static void enqueueForCompilation(Executable ex, CompLevel requestedCompLevel) { 487 if (TestVM.VERBOSE) { 488 System.out.println("enqueueForCompilation " + ex + ", level = " + requestedCompLevel); 489 } 490 CompLevel compLevel = restrictCompLevel(requestedCompLevel); 491 if (compLevel != CompLevel.SKIP) { 492 WHITE_BOX.enqueueMethodForCompilation(ex, compLevel.getValue()); 493 } else { 494 System.out.println("Skipped compilation on level " + requestedCompLevel + " due to VM flags not allowing it."); 495 } 496 } 497 498 /** 499 * Setup @Test annotated method an add them to the declaredTests map to have a convenient way of accessing them 500 * once setting up a framework test (base checked, or custom run test). 501 */ 502 private void setupDeclaredTests() { 503 for (Method m : testClass.getDeclaredMethods()) { 504 Test testAnno = getAnnotation(m, Test.class); 505 try { 506 if (testAnno != null) { 507 addDeclaredTest(m); 508 } else { 509 TestFormat.checkNoThrow(!m.isAnnotationPresent(IR.class) && !m.isAnnotationPresent(IRs.class), 510 "Found @IR annotation on non-@Test method " + m); 511 TestFormat.checkNoThrow(!m.isAnnotationPresent(Warmup.class) || getAnnotation(m, Run.class) != null, 512 "Found @Warmup annotation on non-@Test or non-@Run method " + m); 513 } 514 } catch (TestFormatException e) { 515 // Failure logged. Continue and report later. 516 } 517 } 518 TestFormat.checkNoThrow(!declaredTests.isEmpty(), "Did not specify any @Test methods in " + testClass); 519 } 520 521 private void addDeclaredTest(Method m) { 522 Test testAnno = getAnnotation(m, Test.class); 523 checkTestAnnotations(m, testAnno); 524 Warmup warmup = getAnnotation(m, Warmup.class); 525 int warmupIterations = WARMUP_ITERATIONS; 526 if (warmup != null) { 527 warmupIterations = warmup.value(); 528 TestFormat.checkNoThrow(warmupIterations >= 0, "Cannot have negative value for @Warmup at " + m); 529 } 530 531 if (!IGNORE_COMPILER_CONTROLS) { 532 // Don't inline test methods by default. Do not apply this when -DIgnoreCompilerControls=true is set. 533 WHITE_BOX.testSetDontInlineMethod(m, true); 534 } 535 CompLevel compLevel = restrictCompLevel(testAnno.compLevel()); 536 if (FLIP_C1_C2) { 537 compLevel = compLevel.flipCompLevel(); 538 compLevel = restrictCompLevel(compLevel.flipCompLevel()); 539 } 540 if (EXCLUDE_RANDOM) { 541 compLevel = compLevel.excludeCompilationRandomly(m); 542 } 543 DeclaredTest test = new DeclaredTest(m, ArgumentValue.getArguments(m), compLevel, warmupIterations); 544 declaredTests.put(m, test); 545 testMethodMap.put(m.getName(), m); 546 } 547 548 private void checkTestAnnotations(Method m, Test testAnno) { 549 TestFormat.check(!testMethodMap.containsKey(m.getName()), 550 "Cannot overload two @Test methods: " + m + ", " + testMethodMap.get(m.getName())); 551 TestFormat.check(testAnno != null, m + " must be a method with a @Test annotation"); 552 553 Check checkAnno = getAnnotation(m, Check.class); 554 Run runAnno = getAnnotation(m, Run.class); 555 TestFormat.check(checkAnno == null && runAnno == null, 556 m + " has invalid @Check or @Run annotation while @Test annotation is present."); 557 558 TestFormat.checkNoThrow(Arrays.stream(m.getParameterTypes()).noneMatch(AbstractInfo.class::isAssignableFrom), 559 "Cannot " + AbstractInfo.class + " or any of its subclasses as parameter type at " + 560 "@Test method " + m); 561 562 TestFormat.checkNoThrow(!AbstractInfo.class.isAssignableFrom(m.getReturnType()), 563 "Cannot " + AbstractInfo.class + " or any of its subclasses as return type at " + 564 "@Test method " + m); 565 } 566 567 568 /** 569 * Get the appropriate level as permitted by the test scenario and VM flags. 570 */ 571 private static CompLevel restrictCompLevel(CompLevel compLevel) { 572 if (!USE_COMPILER) { 573 return CompLevel.SKIP; 574 } 575 if (compLevel == CompLevel.ANY) { 576 // Use highest available compilation level by default (usually C2). 577 compLevel = TIERED_COMPILATION_STOP_AT_LEVEL; 578 } 579 if (TEST_C1 && compLevel == CompLevel.C2) { 580 return CompLevel.SKIP; 581 } 582 if ((!TIERED_COMPILATION && !CLIENT_VM) && compLevel.getValue() < CompLevel.C2.getValue()) { 583 return CompLevel.SKIP; 584 } 585 if ((TIERED_COMPILATION || CLIENT_VM) && compLevel.getValue() > TIERED_COMPILATION_STOP_AT_LEVEL.getValue()) { 586 return CompLevel.SKIP; 587 } 588 return compLevel; 589 } 590 591 /** 592 * Verify that the helper classes do not contain illegal framework annotations and then apply the actions as 593 * specified by the different helper class annotations. 594 */ 595 private void processHelperClasses() { 596 if (helperClasses != null) { 597 for (Class<?> helperClass : helperClasses) { 598 // Process the helper classes and apply the explicit compile commands 599 TestFormat.checkNoThrow(helperClass != testClass, 600 "Cannot specify test " + testClass + " as helper class, too."); 601 checkHelperClass(helperClass); 602 processControlAnnotations(helperClass); 603 } 604 } 605 } 606 607 /** 608 * First set up checked (with @Check) and custom run tests (with @Run). All remaining unmatched/unused @Test methods 609 * are treated as base tests and set up as such later. 610 */ 611 private void setupCheckedAndCustomRunTests() { 612 for (Method m : testClass.getDeclaredMethods()) { 613 Check checkAnno = getAnnotation(m, Check.class); 614 Run runAnno = getAnnotation(m, Run.class); 615 Arguments argumentsAnno = getAnnotation(m, Arguments.class); 616 try { 617 TestFormat.check(argumentsAnno == null || (checkAnno == null && runAnno == null), 618 "Cannot have @Argument annotation in combination with @Run or @Check at " + m); 619 if (checkAnno != null) { 620 addCheckedTest(m, checkAnno, runAnno); 621 } else if (runAnno != null) { 622 addCustomRunTest(m, runAnno); 623 } 624 } catch (TestFormatException e) { 625 // Failure logged. Continue and report later. 626 } 627 } 628 } 629 630 /** 631 * Set up a checked test by first verifying the correct format of the @Test and @Check method and then adding it 632 * to the allTests list which keeps track of all framework tests that are eventually executed. 633 */ 634 private void addCheckedTest(Method m, Check checkAnno, Run runAnno) { 635 Method testMethod = testMethodMap.get(checkAnno.test()); 636 DeclaredTest test = declaredTests.get(testMethod); 637 checkCheckedTest(m, checkAnno, runAnno, testMethod, test); 638 test.setAttachedMethod(m); 639 TestFormat.check(getAnnotation(testMethod, Arguments.class) != null || testMethod.getParameterCount() == 0, 640 "Missing @Arguments annotation to define arguments of " + testMethod + " required by " 641 + "checked test " + m); 642 CheckedTest.Parameter parameter = getCheckedTestParameter(m, testMethod); 643 dontCompileAndDontInlineMethod(m); 644 CheckedTest checkedTest = new CheckedTest(test, m, checkAnno, parameter, shouldExcludeTest(testMethod.getName())); 645 allTests.add(checkedTest); 646 if (PRINT_VALID_IR_RULES) { 647 // Only need to emit IR verification information if IR verification is actually performed. 648 irMatchRulePrinter.emitRuleEncoding(testMethod, checkedTest.isSkipped()); 649 } 650 } 651 652 private void checkCheckedTest(Method m, Check checkAnno, Run runAnno, Method testMethod, DeclaredTest test) { 653 TestFormat.check(runAnno == null, m + " has invalid @Run annotation while @Check annotation is present."); 654 TestFormat.check(testMethod != null, "Did not find associated test method \"" + m.getDeclaringClass().getName() 655 + "." + checkAnno.test() + "\" for @Check at " + m); 656 TestFormat.check(test != null, "Missing @Test annotation for associated test method " + testMethod + " for @Check at " + m); 657 Method attachedMethod = test.getAttachedMethod(); 658 TestFormat.check(attachedMethod == null, 659 "Cannot use @Test " + testMethod + " for more than one @Run or one @Check method. Found: " + m + ", " + attachedMethod); 660 } 661 662 /** 663 * Only allow parameters as specified in {@link Check}. 664 */ 665 private CheckedTest.Parameter getCheckedTestParameter(Method m, Method testMethod) { 666 boolean firstParameterTestInfo = m.getParameterCount() > 0 && m.getParameterTypes()[0].equals(TestInfo.class); 667 boolean secondParameterTestInfo = m.getParameterCount() > 1 && m.getParameterTypes()[1].equals(TestInfo.class); 668 CheckedTest.Parameter parameter = null; 669 Class<?> testReturnType = testMethod.getReturnType(); 670 switch (m.getParameterCount()) { 671 case 0 -> parameter = CheckedTest.Parameter.NONE; 672 case 1 -> { 673 TestFormat.checkNoThrow(firstParameterTestInfo || m.getParameterTypes()[0] == testReturnType, 674 "Single-parameter version of @Check method " + m + " must match return type of @Test " + testMethod); 675 parameter = firstParameterTestInfo ? CheckedTest.Parameter.TEST_INFO_ONLY : CheckedTest.Parameter.RETURN_ONLY; 676 } 677 case 2 -> { 678 TestFormat.checkNoThrow(m.getParameterTypes()[0] == testReturnType && secondParameterTestInfo, 679 "Two-parameter version of @Check method " + m + " must provide as first parameter the same" 680 + " return type as @Test method " + testMethod + " and as second parameter an object of " + TestInfo.class); 681 parameter = CheckedTest.Parameter.BOTH; 682 } 683 default -> TestFormat.failNoThrow("@Check method " + m + " must provide either a none, single or two-parameter variant."); 684 } 685 return parameter; 686 } 687 688 /** 689 * Set up a custom run test by first verifying the correct format of the @Test and @Run method and then adding it 690 * to the allTests list which keeps track of all framework tests that are eventually executed. 691 */ 692 private void addCustomRunTest(Method m, Run runAnno) { 693 checkRunMethod(m, runAnno); 694 List<DeclaredTest> tests = new ArrayList<>(); 695 boolean shouldExcludeTest = true; 696 for (String testName : runAnno.test()) { 697 try { 698 Method testMethod = testMethodMap.get(testName); 699 DeclaredTest test = declaredTests.get(testMethod); 700 checkCustomRunTest(m, testName, testMethod, test, runAnno.mode()); 701 test.setAttachedMethod(m); 702 tests.add(test); 703 // Only exclude custom run test if all test methods excluded 704 shouldExcludeTest &= shouldExcludeTest(testMethod.getName()); 705 } catch (TestFormatException e) { 706 // Logged, continue. 707 } 708 } 709 if (tests.isEmpty()) { 710 return; // There was a format violation. Return. 711 } 712 dontCompileAndDontInlineMethod(m); 713 CustomRunTest customRunTest = new CustomRunTest(m, getAnnotation(m, Warmup.class), runAnno, tests, shouldExcludeTest); 714 allTests.add(customRunTest); 715 if (PRINT_VALID_IR_RULES) { 716 tests.forEach(test -> irMatchRulePrinter.emitRuleEncoding(test.getTestMethod(), customRunTest.isSkipped())); 717 } 718 } 719 720 /** 721 * Only allow parameters as specified in {@link Run}. 722 */ 723 private void checkCustomRunTest(Method m, String testName, Method testMethod, DeclaredTest test, RunMode runMode) { 724 TestFormat.check(testMethod != null, "Did not find associated @Test method \"" + m.getDeclaringClass().getName() 725 + "." + testName + "\" specified in @Run at " + m); 726 TestFormat.check(test != null, 727 "Missing @Test annotation for associated test method " + testName + " for @Run at " + m); 728 Method attachedMethod = test.getAttachedMethod(); 729 TestFormat.check(attachedMethod == null, 730 "Cannot use @Test " + testMethod + " for more than one @Run/@Check method. Found: " 731 + m + ", " + attachedMethod); 732 TestFormat.check(!test.hasArguments(), 733 "Cannot use @Arguments at test method " + testMethod + " in combination with @Run method " + m); 734 Warmup warmupAnno = getAnnotation(testMethod, Warmup.class); 735 TestFormat.checkNoThrow(warmupAnno == null, 736 "Cannot set @Warmup at @Test method " + testMethod + " when used with its @Run method " 737 + m + ". Use @Warmup at @Run method instead."); 738 Test testAnno = getAnnotation(testMethod, Test.class); 739 TestFormat.checkNoThrow(runMode != RunMode.STANDALONE || testAnno.compLevel() == CompLevel.ANY, 740 "Setting explicit compilation level for @Test method " + testMethod + " has no effect " 741 + "when used with STANDALONE @Run method " + m); 742 } 743 744 private void checkRunMethod(Method m, Run runAnno) { 745 TestFormat.check(runAnno.test().length > 0, "@Run method " + m + " must specify at least one test method"); 746 TestFormat.checkNoThrow(m.getParameterCount() == 0 || (m.getParameterCount() == 1 && m.getParameterTypes()[0].equals(RunInfo.class)), 747 "@Run method " + m + " must specify either no parameter or exactly one " + RunInfo.class + " parameter."); 748 Warmup warmupAnno = getAnnotation(m, Warmup.class); 749 TestFormat.checkNoThrow(warmupAnno == null || runAnno.mode() != RunMode.STANDALONE, 750 "Cannot set @Warmup at @Run method " + m + " when used with RunMode.STANDALONE. The @Run method is only invoked once."); 751 } 752 753 private static <T extends Annotation> T getAnnotation(AnnotatedElement element, Class<T> c) { 754 T[] annos = element.getAnnotationsByType(c); 755 TestFormat.check(annos.length < 2, element + " has duplicated annotations"); 756 return Arrays.stream(annos).findFirst().orElse(null); 757 } 758 759 /** 760 * Ensure that all compilations that were enforced (added to compilation queue) by framework annotations are 761 * completed. Wait if necessary for a short amount of time for their completion. 762 */ 763 private void checkForcedCompilationsCompleted() { 764 if (forceCompileMap.isEmpty()) { 765 return; 766 } 767 final long started = System.currentTimeMillis(); 768 long elapsed; 769 do { 770 forceCompileMap.entrySet().removeIf(entry -> WHITE_BOX.getMethodCompilationLevel(entry.getKey()) == entry.getValue().getValue()); 771 if (forceCompileMap.isEmpty()) { 772 // All @ForceCompile methods are compiled at the requested level. 773 return; 774 } 775 // Retry again if not yet compiled. 776 forceCompileMap.forEach(TestVM::enqueueForCompilation); 777 elapsed = System.currentTimeMillis() - started; 778 } while (elapsed < 5000); 779 StringBuilder builder = new StringBuilder(); 780 forceCompileMap.forEach((key, value) -> builder.append("- ").append(key).append(" at CompLevel.").append(value) 781 .append(System.lineSeparator())); 782 throw new TestRunException("Could not force compile the following @ForceCompile methods:" 783 + System.lineSeparator() + builder.toString()); 784 } 785 786 /** 787 * Once all framework tests are collected, they are run in this method. 788 */ 789 private void runTests() { 790 TreeMap<Long, String> durations = (PRINT_TIMES || VERBOSE) ? new TreeMap<>() : null; 791 long startTime = System.nanoTime(); 792 List<AbstractTest> testList; 793 boolean testFilterPresent = testFilterPresent(); 794 if (testFilterPresent) { 795 // Only run the specified tests by the user filters -DTest and/or -DExclude. 796 testList = allTests.stream().filter(test -> !test.isSkipped()).collect(Collectors.toList()); 797 if (testList.isEmpty()) { 798 // Throw an exception to inform the user about an empty specified test set with -DTest and/or -DExclude 799 throw new NoTestsRunException(); 800 } 801 } else { 802 testList = allTests; 803 } 804 805 if (SHUFFLE_TESTS) { 806 // Execute tests in random order (execution sequence affects profiling). This is done by default. 807 Collections.shuffle(testList, Utils.getRandomInstance()); 808 } 809 StringBuilder builder = new StringBuilder(); 810 int failures = 0; 811 812 // Execute all tests and keep track of each exception that is thrown. These are then reported once all tests 813 // are executing. This prevents a premature exit without running all tests. 814 for (AbstractTest test : testList) { 815 if (VERBOSE) { 816 System.out.println("Run " + test.toString()); 817 } 818 if (testFilterPresent) { 819 TestFrameworkSocket.write("Run " + test.toString(), TestFrameworkSocket.TESTLIST_TAG, true); 820 } 821 try { 822 test.run(); 823 } catch (TestRunException e) { 824 StringWriter sw = new StringWriter(); 825 PrintWriter pw = new PrintWriter(sw); 826 e.printStackTrace(pw); 827 builder.append(test.toString()).append(":").append(System.lineSeparator()).append(sw.toString()) 828 .append(System.lineSeparator()).append(System.lineSeparator()); 829 failures++; 830 } 831 if (PRINT_TIMES || VERBOSE) { 832 long endTime = System.nanoTime(); 833 long duration = (endTime - startTime); 834 durations.put(duration, test.getName()); 835 if (VERBOSE) { 836 System.out.println("Done " + test.getName() + ": " + duration + " ns = " + (duration / 1000000) + " ms"); 837 } 838 } 839 if (GC_AFTER) { 840 System.out.println("doing GC"); 841 WHITE_BOX.fullGC(); 842 } 843 } 844 845 // Print execution times 846 if (VERBOSE || PRINT_TIMES) { 847 System.out.println(System.lineSeparator() + System.lineSeparator() + "Test execution times:"); 848 for (Map.Entry<Long, String> entry : durations.entrySet()) { 849 System.out.format("%-10s%15d ns%n", entry.getValue() + ":", entry.getKey()); 850 } 851 } 852 853 if (failures > 0) { 854 // Finally, report all occurred exceptions in a nice format. 855 String msg = System.lineSeparator() + System.lineSeparator() + "Test Failures (" + failures + ")" 856 + System.lineSeparator() + "----------------" + "-".repeat(String.valueOf(failures).length()); 857 throw new TestRunException(msg + System.lineSeparator() + builder.toString()); 858 } 859 } 860 861 private boolean testFilterPresent() { 862 return testList != null || excludeList != null; 863 } 864 865 enum TriState { 866 Maybe, 867 Yes, 868 No 869 } 870 871 public static void compile(Method m, CompLevel compLevel) { 872 TestRun.check(compLevel != CompLevel.SKIP && compLevel != CompLevel.WAIT_FOR_COMPILATION, 873 "Invalid compilation request with level " + compLevel); 874 enqueueForCompilation(m, compLevel); 875 } 876 877 public static void deoptimize(Method m) { 878 WHITE_BOX.deoptimizeMethod(m); 879 } 880 881 public static boolean isCompiled(Method m) { 882 return compiledAtLevel(m, CompLevel.ANY) == TriState.Yes; 883 } 884 885 public static boolean isC1Compiled(Method m) { 886 return compiledByC1(m) == TriState.Yes; 887 } 888 889 public static boolean isC2Compiled(Method m) { 890 return compiledByC2(m) == TriState.Yes; 891 } 892 893 public static boolean isCompiledAtLevel(Method m, CompLevel compLevel) { 894 return compiledAtLevel(m, compLevel) == TriState.Yes; 895 } 896 897 public static void assertDeoptimizedByC1(Method m) { 898 if (notUnstableDeoptAssertion(m, CompLevel.C1_SIMPLE)) { 899 TestRun.check(compiledByC1(m) != TriState.Yes || PER_METHOD_TRAP_LIMIT == 0 || !PROFILE_INTERPRETER, 900 m + " should have been deoptimized by C1"); 901 } 902 } 903 904 public static void assertDeoptimizedByC2(Method m) { 905 if (notUnstableDeoptAssertion(m, CompLevel.C2)) { 906 TestRun.check(compiledByC2(m) != TriState.Yes || PER_METHOD_TRAP_LIMIT == 0 || !PROFILE_INTERPRETER, 907 m + " should have been deoptimized by C2"); 908 } 909 } 910 911 /** 912 * Some VM flags could make the deopt assertions unstable. 913 */ 914 private static boolean notUnstableDeoptAssertion(Method m, CompLevel level) { 915 return (USE_COMPILER && !XCOMP && !IGNORE_COMPILER_CONTROLS && !TEST_C1 && 916 (!EXCLUDE_RANDOM || WHITE_BOX.isMethodCompilable(m, level.getValue(), false))); 917 } 918 919 public static void assertCompiledByC1(Method m) { 920 TestRun.check(compiledByC1(m) != TriState.No, m + " should have been C1 compiled"); 921 } 922 923 public static void assertCompiledByC2(Method m) { 924 TestRun.check(compiledByC2(m) != TriState.No, m + " should have been C2 compiled"); 925 } 926 927 public static void assertCompiledAtLevel(Method m, CompLevel level) { 928 TestRun.check(compiledAtLevel(m, level) != TriState.No, m + " should have been compiled at level " + level.name()); 929 } 930 931 public static void assertNotCompiled(Method m) { 932 TestRun.check(!isC1Compiled(m), m + " should not have been compiled by C1"); 933 TestRun.check(!isC2Compiled(m), m + " should not have been compiled by C2"); 934 } 935 936 public static void assertCompiled(Method m) { 937 TestRun.check(compiledByC1(m) != TriState.No || compiledByC2(m) != TriState.No, m + " should have been compiled"); 938 } 939 940 private static TriState compiledByC1(Method m) { 941 TriState triState = compiledAtLevel(m, CompLevel.C1_SIMPLE); 942 if (triState != TriState.No) { 943 return triState; 944 } 945 triState = compiledAtLevel(m, CompLevel.C1_LIMITED_PROFILE); 946 if (triState != TriState.No) { 947 return triState; 948 } 949 triState = compiledAtLevel(m, CompLevel.C1_FULL_PROFILE); 950 return triState; 951 } 952 953 private static TriState compiledByC2(Method m) { 954 return compiledAtLevel(m, CompLevel.C2); 955 } 956 957 private static TriState compiledAtLevel(Method m, CompLevel level) { 958 if (WHITE_BOX.isMethodCompiled(m, false)) { 959 switch (level) { 960 case C1_SIMPLE, C1_LIMITED_PROFILE, C1_FULL_PROFILE, C2 -> { 961 if (WHITE_BOX.getMethodCompilationLevel(m, false) == level.getValue()) { 962 return TriState.Yes; 963 } 964 } 965 case ANY -> { 966 return TriState.Yes; 967 } 968 default -> throw new TestRunException("compiledAtLevel() should not be called with " + level); 969 } 970 } 971 if (!USE_COMPILER || XCOMP || TEST_C1 || IGNORE_COMPILER_CONTROLS || FLIP_C1_C2 || 972 (EXCLUDE_RANDOM && !WHITE_BOX.isMethodCompilable(m, level.getValue(), false))) { 973 return TriState.Maybe; 974 } 975 return TriState.No; 976 } 977 }