1 /*
   2  * Copyright (c) 2014, 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 import com.oracle.testlibrary.jsr292.Helper;
  25 import com.sun.management.HotSpotDiagnosticMXBean;
  26 import java.lang.management.ManagementFactory;
  27 import java.lang.reflect.Method;
  28 import java.util.Collection;
  29 import java.util.function.Function;
  30 import jdk.testlibrary.Utils;
  31 
  32 /**
  33  * Lambda forms caching test case class. Contains all necessary test routines to
  34  * test lambda forms caching in method handles returned by methods of
  35  * MethodHandles class.
  36  *
  37  * @author kshefov
  38  */
  39 public abstract class LambdaFormTestCase {
  40 
  41     private final static String METHOD_HANDLE_CLASS_NAME = "java.lang.invoke.MethodHandle";
  42     private final static String INTERNAL_FORM_METHOD_NAME = "internalForm";
  43     private static final double ITERATIONS_TO_CODE_CACHE_SIZE_RATIO
  44             = 45 / (128.0 * 1024 * 1024);
  45     private static final long TIMEOUT = Utils.adjustTimeout(Utils.DEFAULT_TEST_TIMEOUT);
  46     
  47     /**
  48      * Reflection link to {@code j.l.i.MethodHandle.internalForm} method. It is
  49      * used to get a lambda form from a method handle.
  50      */
  51     protected final static Method INTERNAL_FORM;
  52 
  53     static {
  54         try {
  55             Class mhClass = Class.forName(METHOD_HANDLE_CLASS_NAME);
  56             INTERNAL_FORM = mhClass.getDeclaredMethod(INTERNAL_FORM_METHOD_NAME);
  57             INTERNAL_FORM.setAccessible(true);
  58         } catch (Exception ex) {
  59             throw new Error("Unexpected exception: ", ex);
  60         }
  61     }
  62 
  63     private final TestMethods testMethod;
  64 
  65     /**
  66      * Test case constructor. Generates test cases with random method types for
  67      * given methods form {@code j.l.i.MethodHandles} class.
  68      *
  69      * @param testMethod A method from {@code j.l.i.MethodHandles} class which
  70      * returns a {@code j.l.i.MethodHandle}.
  71      */
  72     protected LambdaFormTestCase(TestMethods testMethod) {
  73         this.testMethod = testMethod;
  74     }
  75 
  76     public TestMethods getTestMethod() {
  77         return testMethod;
  78     }
  79 
  80     /**
  81      * Routine that executes a test case.
  82      */
  83     public abstract void doTest();
  84 
  85     /**
  86      * Runs a number of test cases defined by the size of testCases list.
  87      *
  88      * @param ctor constructor of LambdaFormCachingTest or its child classes
  89      * object.
  90      * @param testMethods list of test methods
  91      */
  92     public static void runTests(Function<TestMethods, LambdaFormTestCase> ctor, Collection<TestMethods> testMethods) {
  93         boolean passed = true;
  94         int testCounter = 0;
  95         int failCounter = 0;
  96         long testCaseNum = testMethods.size();
  97         long iterations = Math.max(1, Helper.TEST_LIMIT / testCaseNum);
  98         System.out.printf("Number of iterations according to -DtestLimit is %d (%d cases)%n",
  99                 iterations, iterations * testCaseNum);
 100         HotSpotDiagnosticMXBean hsDiagBean = ManagementFactory.getPlatformMXBean(HotSpotDiagnosticMXBean.class);
 101         long codeCacheSize = Long.parseLong(
 102                 hsDiagBean.getVMOption("ReservedCodeCacheSize").getValue());
 103         System.out.printf("Code Cache Size is %d bytes%n", codeCacheSize);
 104         long iterationsByCodeCacheSize = (long) (codeCacheSize
 105                 * ITERATIONS_TO_CODE_CACHE_SIZE_RATIO);
 106         System.out.printf("Number of iterations limited by code cache size is %d (%d cases)%n",
 107                 iterationsByCodeCacheSize, iterationsByCodeCacheSize * testCaseNum);
 108         if (iterations > iterationsByCodeCacheSize) {
 109             iterations = iterationsByCodeCacheSize;
 110         }
 111         System.out.printf("Number of iterations is set to %d (%d cases)%n",
 112                 iterations, iterations * testCaseNum);
 113         System.out.flush();
 114         long maxIterTime = 0;
 115         long startTime = System.currentTimeMillis();
 116         for (long i = 0; i < iterations; i++) {
 117             long startIterTime = System.currentTimeMillis();
 118             System.err.println(String.format("Iteration %d:", i));
 119             for (TestMethods testMethod : testMethods) {
 120                 LambdaFormTestCase testCase = ctor.apply(testMethod);
 121                 try {
 122                     System.err.printf("Tested LF caching feature with MethodHandles.%s method.%n",
 123                             testCase.getTestMethod().name);
 124                     testCase.doTest();
 125                     System.err.println("PASSED");
 126                 } catch (Throwable t) {
 127                     t.printStackTrace();
 128                     System.err.println("FAILED");
 129                     passed = false;
 130                     failCounter++;
 131                 }
 132                 testCounter++;
 133             }
 134             long passedTime = System.currentTimeMillis() - startTime;
 135             long iterTime = System.currentTimeMillis() - startIterTime;
 136             maxIterTime = Math.max(maxIterTime, iterTime);
 137             long remainTime = TIMEOUT - passedTime;
 138             if (4 * maxIterTime > remainTime) {
 139                 System.err.printf("Stopping iterations because of lack of time.%n"
 140                         + "Increase timeout factor for more iterations.%n");
 141                 break;
 142             }
 143         }
 144         if (!passed) {
 145             throw new Error(String.format("%d of %d test cases FAILED! %n"
 146                     + "Rerun the test with the same \"-Dseed=\" option as in the log file!",
 147                     failCounter, testCounter));
 148         } else {
 149             System.err.println(String.format("All %d test cases PASSED!", testCounter));
 150         }
 151     }
 152 }