| /* |
| * Copyright (c) 2014, 2016, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| /* |
| * Common code for string deduplication tests |
| */ |
| |
| import java.lang.management.*; |
| import java.lang.reflect.*; |
| import java.security.*; |
| import java.util.*; |
| import jdk.test.lib.process.ProcessTools; |
| import jdk.test.lib.process.OutputAnalyzer; |
| import sun.misc.*; |
| |
| class TestStringDeduplicationTools { |
| private static final String YoungGC = "YoungGC"; |
| private static final String FullGC = "FullGC"; |
| |
| private static final int Xmn = 50; // MB |
| private static final int Xms = 100; // MB |
| private static final int Xmx = 100; // MB |
| private static final int MB = 1024 * 1024; |
| private static final int StringLength = 50; |
| |
| private static Field valueField; |
| private static Unsafe unsafe; |
| private static byte[] dummy; |
| |
| static { |
| try { |
| Field field = Unsafe.class.getDeclaredField("theUnsafe"); |
| field.setAccessible(true); |
| unsafe = (Unsafe)field.get(null); |
| |
| valueField = String.class.getDeclaredField("value"); |
| valueField.setAccessible(true); |
| } catch (Exception e) { |
| throw new RuntimeException(e); |
| } |
| } |
| |
| private static Object getValue(String string) { |
| try { |
| return valueField.get(string); |
| } catch (Exception e) { |
| throw new RuntimeException(e); |
| } |
| } |
| |
| private static void doFullGc(int numberOfTimes) { |
| for (int i = 0; i < numberOfTimes; i++) { |
| System.out.println("Begin: Full GC " + (i + 1) + "/" + numberOfTimes); |
| System.gc(); |
| System.out.println("End: Full GC " + (i + 1) + "/" + numberOfTimes); |
| } |
| } |
| |
| private static void doYoungGc(int numberOfTimes) { |
| // Provoke at least numberOfTimes young GCs |
| final int objectSize = 128; |
| final int maxObjectInYoung = (Xmn * MB) / objectSize; |
| for (int i = 0; i < numberOfTimes; i++) { |
| System.out.println("Begin: Young GC " + (i + 1) + "/" + numberOfTimes); |
| for (int j = 0; j < maxObjectInYoung + 1; j++) { |
| dummy = new byte[objectSize]; |
| } |
| System.out.println("End: Young GC " + (i + 1) + "/" + numberOfTimes); |
| } |
| } |
| |
| private static void forceDeduplication(int ageThreshold, String gcType) { |
| // Force deduplication to happen by either causing a FullGC or a YoungGC. |
| // We do several collections to also provoke a situation where the the |
| // deduplication thread needs to yield while processing the queue. This |
| // also tests that the references in the deduplication queue are adjusted |
| // accordingly. |
| if (gcType.equals(FullGC)) { |
| doFullGc(3); |
| } else { |
| doYoungGc(ageThreshold + 3); |
| } |
| } |
| |
| private static String generateString(int id) { |
| StringBuilder builder = new StringBuilder(StringLength); |
| |
| builder.append("DeduplicationTestString:" + id + ":"); |
| |
| while (builder.length() < StringLength) { |
| builder.append('X'); |
| } |
| |
| return builder.toString(); |
| } |
| |
| private static ArrayList<String> createStrings(int total, int unique) { |
| System.out.println("Creating strings: total=" + total + ", unique=" + unique); |
| if (total % unique != 0) { |
| throw new RuntimeException("Total must be divisible by unique"); |
| } |
| |
| ArrayList<String> list = new ArrayList<String>(total); |
| for (int j = 0; j < total / unique; j++) { |
| for (int i = 0; i < unique; i++) { |
| list.add(generateString(i)); |
| } |
| } |
| |
| return list; |
| } |
| |
| /** |
| * Verifies that the given list contains expected number of unique strings. |
| * It's possible that deduplication hasn't completed yet, so the method |
| * will perform several attempts to check with a little pause between. |
| * The method throws RuntimeException to signal that verification failed. |
| * |
| * @param list strings to check |
| * @param uniqueExpected expected number of unique strings |
| * @throws RuntimeException if check fails |
| */ |
| private static void verifyStrings(ArrayList<String> list, int uniqueExpected) { |
| boolean passed = false; |
| for (int attempts = 0; attempts < 10; attempts++) { |
| // Check number of deduplicated strings |
| ArrayList<Object> unique = new ArrayList<Object>(uniqueExpected); |
| for (String string: list) { |
| Object value = getValue(string); |
| boolean uniqueValue = true; |
| for (Object obj: unique) { |
| if (obj == value) { |
| uniqueValue = false; |
| break; |
| } |
| } |
| |
| if (uniqueValue) { |
| unique.add(value); |
| } |
| } |
| |
| System.out.println("Verifying strings: total=" + list.size() + |
| ", uniqueFound=" + unique.size() + |
| ", uniqueExpected=" + uniqueExpected); |
| |
| if (unique.size() == uniqueExpected) { |
| System.out.println("Deduplication completed (as fast as " + attempts + " iterations)"); |
| passed = true; |
| break; |
| } else { |
| System.out.println("Deduplication not completed, waiting..."); |
| // Give the deduplication thread time to complete |
| try { |
| Thread.sleep(1000); |
| } catch (Exception e) { |
| throw new RuntimeException(e); |
| } |
| } |
| } |
| if (!passed) { |
| throw new RuntimeException("String verification failed"); |
| } |
| } |
| |
| private static OutputAnalyzer runTest(String... extraArgs) throws Exception { |
| String[] defaultArgs = new String[] { |
| "-Xmn" + Xmn + "m", |
| "-Xms" + Xms + "m", |
| "-Xmx" + Xmx + "m", |
| "-XX:+UseG1GC", |
| "-XX:+UnlockDiagnosticVMOptions", |
| "--add-opens=java.base/java.lang=ALL-UNNAMED", |
| "-XX:+VerifyAfterGC" // Always verify after GC |
| }; |
| |
| ArrayList<String> args = new ArrayList<String>(); |
| args.addAll(Arrays.asList(defaultArgs)); |
| args.addAll(Arrays.asList(extraArgs)); |
| |
| ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(args.toArray(new String[args.size()])); |
| OutputAnalyzer output = new OutputAnalyzer(pb.start()); |
| System.err.println(output.getStderr()); |
| System.out.println(output.getStdout()); |
| return output; |
| } |
| |
| private static class DeduplicationTest { |
| public static void main(String[] args) { |
| System.out.println("Begin: DeduplicationTest"); |
| |
| final int numberOfStrings = Integer.parseUnsignedInt(args[0]); |
| final int numberOfUniqueStrings = Integer.parseUnsignedInt(args[1]); |
| final int ageThreshold = Integer.parseUnsignedInt(args[2]); |
| final String gcType = args[3]; |
| |
| ArrayList<String> list = createStrings(numberOfStrings, numberOfUniqueStrings); |
| forceDeduplication(ageThreshold, gcType); |
| verifyStrings(list, numberOfUniqueStrings); |
| |
| System.out.println("End: DeduplicationTest"); |
| } |
| |
| public static OutputAnalyzer run(int numberOfStrings, int ageThreshold, String gcType, String... extraArgs) throws Exception { |
| String[] defaultArgs = new String[] { |
| "-XX:+UseStringDeduplication", |
| "-XX:StringDeduplicationAgeThreshold=" + ageThreshold, |
| DeduplicationTest.class.getName(), |
| "" + numberOfStrings, |
| "" + numberOfStrings / 2, |
| "" + ageThreshold, |
| gcType |
| }; |
| |
| ArrayList<String> args = new ArrayList<String>(); |
| args.addAll(Arrays.asList(extraArgs)); |
| args.addAll(Arrays.asList(defaultArgs)); |
| |
| return runTest(args.toArray(new String[args.size()])); |
| } |
| } |
| |
| private static class InternedTest { |
| public static void main(String[] args) { |
| // This test verifies that interned strings are always |
| // deduplicated when being interned, and never after |
| // being interned. |
| |
| System.out.println("Begin: InternedTest"); |
| |
| final int ageThreshold = Integer.parseUnsignedInt(args[0]); |
| final String baseString = "DeduplicationTestString:" + InternedTest.class.getName(); |
| |
| // Create duplicate of baseString |
| StringBuilder sb1 = new StringBuilder(baseString); |
| String dupString1 = sb1.toString(); |
| if (getValue(dupString1) == getValue(baseString)) { |
| throw new RuntimeException("Values should not match"); |
| } |
| |
| // Force baseString to be inspected for deduplication |
| // and be inserted into the deduplication hashtable. |
| forceDeduplication(ageThreshold, FullGC); |
| |
| // Wait for deduplication to occur |
| for (int attempts = 0; attempts < 10; attempts++) { |
| if (getValue(dupString1) == getValue(baseString)) { |
| break; |
| } |
| System.out.println("Waiting..."); |
| try { |
| Thread.sleep(1000); |
| } catch (Exception e) { |
| throw new RuntimeException(e); |
| } |
| } |
| if (getValue(dupString1) != getValue(baseString)) { |
| throw new RuntimeException("Deduplication has not occurred"); |
| } |
| |
| // Create a new duplicate of baseString |
| StringBuilder sb2 = new StringBuilder(baseString); |
| String dupString2 = sb2.toString(); |
| if (getValue(dupString2) == getValue(baseString)) { |
| throw new RuntimeException("Values should not match"); |
| } |
| |
| // Intern the new duplicate |
| Object beforeInternedValue = getValue(dupString2); |
| String internedString = dupString2.intern(); |
| if (internedString != dupString2) { |
| throw new RuntimeException("String should match"); |
| } |
| if (getValue(internedString) != getValue(baseString)) { |
| throw new RuntimeException("Values should match"); |
| } |
| |
| // Check original value of interned string, to make sure |
| // deduplication happened on the interned string and not |
| // on the base string |
| if (beforeInternedValue == getValue(baseString)) { |
| throw new RuntimeException("Values should not match"); |
| } |
| |
| System.out.println("End: InternedTest"); |
| } |
| |
| public static OutputAnalyzer run() throws Exception { |
| return runTest("-Xlog:gc=debug,gc+stringdedup=trace", |
| "-XX:+UseStringDeduplication", |
| "-XX:StringDeduplicationAgeThreshold=" + DefaultAgeThreshold, |
| InternedTest.class.getName(), |
| "" + DefaultAgeThreshold); |
| } |
| } |
| |
| /* |
| * Tests |
| */ |
| |
| private static final int LargeNumberOfStrings = 10000; |
| private static final int SmallNumberOfStrings = 10; |
| |
| private static final int MaxAgeThreshold = 15; |
| private static final int DefaultAgeThreshold = 3; |
| private static final int MinAgeThreshold = 1; |
| |
| private static final int TooLowAgeThreshold = MinAgeThreshold - 1; |
| private static final int TooHighAgeThreshold = MaxAgeThreshold + 1; |
| |
| public static void testYoungGC() throws Exception { |
| // Do young GC to age strings to provoke deduplication |
| OutputAnalyzer output = DeduplicationTest.run(LargeNumberOfStrings, |
| DefaultAgeThreshold, |
| YoungGC, |
| "-Xlog:gc,gc+stringdedup=trace"); |
| output.shouldNotContain("Full GC"); |
| output.shouldContain("Pause Young (G1 Evacuation Pause)"); |
| output.shouldContain("Concurrent String Deduplication"); |
| output.shouldContain("Deduplicated:"); |
| output.shouldHaveExitValue(0); |
| } |
| |
| public static void testFullGC() throws Exception { |
| // Do full GC to age strings to provoke deduplication |
| OutputAnalyzer output = DeduplicationTest.run(LargeNumberOfStrings, |
| DefaultAgeThreshold, |
| FullGC, |
| "-Xlog:gc,gc+stringdedup=trace"); |
| output.shouldNotContain("Pause Young (G1 Evacuation Pause)"); |
| output.shouldContain("Full GC"); |
| output.shouldContain("Concurrent String Deduplication"); |
| output.shouldContain("Deduplicated:"); |
| output.shouldHaveExitValue(0); |
| } |
| |
| public static void testTableResize() throws Exception { |
| // Test with StringDeduplicationResizeALot |
| OutputAnalyzer output = DeduplicationTest.run(LargeNumberOfStrings, |
| DefaultAgeThreshold, |
| YoungGC, |
| "-Xlog:gc,gc+stringdedup=trace", |
| "-XX:+StringDeduplicationResizeALot"); |
| output.shouldContain("Concurrent String Deduplication"); |
| output.shouldContain("Deduplicated:"); |
| output.shouldNotContain("Resize Count: 0"); |
| output.shouldHaveExitValue(0); |
| } |
| |
| public static void testTableRehash() throws Exception { |
| // Test with StringDeduplicationRehashALot |
| OutputAnalyzer output = DeduplicationTest.run(LargeNumberOfStrings, |
| DefaultAgeThreshold, |
| YoungGC, |
| "-Xlog:gc,gc+stringdedup=trace", |
| "-XX:+StringDeduplicationRehashALot"); |
| output.shouldContain("Concurrent String Deduplication"); |
| output.shouldContain("Deduplicated:"); |
| output.shouldNotContain("Rehash Count: 0"); |
| output.shouldNotContain("Hash Seed: 0x0"); |
| output.shouldHaveExitValue(0); |
| } |
| |
| public static void testAgeThreshold() throws Exception { |
| OutputAnalyzer output; |
| |
| // Test with max age theshold |
| output = DeduplicationTest.run(SmallNumberOfStrings, |
| MaxAgeThreshold, |
| YoungGC, |
| "-Xlog:gc,gc+stringdedup=trace"); |
| output.shouldContain("Concurrent String Deduplication"); |
| output.shouldContain("Deduplicated:"); |
| output.shouldHaveExitValue(0); |
| |
| // Test with min age theshold |
| output = DeduplicationTest.run(SmallNumberOfStrings, |
| MinAgeThreshold, |
| YoungGC, |
| "-Xlog:gc,gc+stringdedup=trace"); |
| output.shouldContain("Concurrent String Deduplication"); |
| output.shouldContain("Deduplicated:"); |
| output.shouldHaveExitValue(0); |
| |
| // Test with too low age threshold |
| output = DeduplicationTest.run(SmallNumberOfStrings, |
| TooLowAgeThreshold, |
| YoungGC); |
| output.shouldContain("outside the allowed range"); |
| output.shouldHaveExitValue(1); |
| |
| // Test with too high age threshold |
| output = DeduplicationTest.run(SmallNumberOfStrings, |
| TooHighAgeThreshold, |
| YoungGC); |
| output.shouldContain("outside the allowed range"); |
| output.shouldHaveExitValue(1); |
| } |
| |
| public static void testPrintOptions() throws Exception { |
| OutputAnalyzer output; |
| |
| // Test without -Xlog:gc |
| output = DeduplicationTest.run(SmallNumberOfStrings, |
| DefaultAgeThreshold, |
| YoungGC); |
| output.shouldNotContain("Concurrent String Deduplication"); |
| output.shouldNotContain("Deduplicated:"); |
| output.shouldHaveExitValue(0); |
| |
| // Test with -Xlog:gc+stringdedup |
| output = DeduplicationTest.run(SmallNumberOfStrings, |
| DefaultAgeThreshold, |
| YoungGC, |
| "-Xlog:gc+stringdedup"); |
| output.shouldContain("Concurrent String Deduplication"); |
| output.shouldNotContain("Deduplicated:"); |
| output.shouldHaveExitValue(0); |
| } |
| |
| public static void testInterned() throws Exception { |
| // Test that interned strings are deduplicated before being interned |
| OutputAnalyzer output = InternedTest.run(); |
| output.shouldHaveExitValue(0); |
| } |
| } |