Bug#36805638 (noclose) NdbRecordSmartValueHandlerImpl leaking memory

This patch contains some improvements to the testing
and diagnostic facilities in Cluster/J.

 * A new test case, BlobInstanceTest, aiming to reproduce
   the reported problem.

 * Changes to AllTests.java
     - Display the Java version when running tests
     - New option --gc=<n> runs <n> iterations of GC after testing.
     - New option --hprof creates a Java heap dump on exit

 * Fix a bug that caused TestRunner to incorrectly report
   "No tests run" if all tests fail.

 * Changes to testClusterJ
     - Do not create default properties
     - Start Java with assertions enabled
     - If LOG_GC is set in the environment, start Java with GC logging
       enabled

 * Changes to Cluster/J internals
     - Change the level of some log messages from info to debug

Change-Id: Ic8b6e84e2632701fce781d923a1954a9d035b24a

Author: jdduncan

storage/ndb/clusterj/clusterj-test/CMakeLists.txt

@@ -46,6 +46,7 @@ SET(JAVA_SOURCES
   ${CLUSTERJ_TESTSUITE_PREFIX}/BinaryPKTest.java
   ${CLUSTERJ_TESTSUITE_PREFIX}/BinaryTypesTest.java
   ${CLUSTERJ_TESTSUITE_PREFIX}/BitTypesTest.java
+  ${CLUSTERJ_TESTSUITE_PREFIX}/BlobInstanceTest.java
   ${CLUSTERJ_TESTSUITE_PREFIX}/BlobTest.java
   ${CLUSTERJ_TESTSUITE_PREFIX}/BulkDeleteTest.java
   ${CLUSTERJ_TESTSUITE_PREFIX}/Bug17200163Test.java

storage/ndb/clusterj/clusterj-test/src/main/java/testsuite/clusterj/AllTests.java

@@ -25,10 +25,13 @@ This program is designed to work with certain software (including
 
 package testsuite.clusterj;
 
+import com.sun.management.HotSpotDiagnosticMXBean;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.lang.annotation.Annotation;
+import java.lang.management.ManagementFactory;
+import java.lang.Process;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
@@ -55,6 +58,8 @@ private static void usage(String message) {
         System.out.println("  Options: ");
         System.out.println("     --print-cases / -l   : List test cases");
         System.out.println("     --enable-debug-tests : Run extra debug-only tests");
+        System.out.println("     --gc=<n>             : Run <n> GC iterations after tests");
+        System.out.println("     --hprof              : Create heap dump at exit");
         System.out.println("     -n TestName [...]    : Run named tests");
         System.exit(2);
     }
@@ -165,6 +170,13 @@ public static void printCases() throws IOException, ClassNotFoundException {
         }
     }
 
+    private static void tryGc(int n) throws InterruptedException {
+        System.out.println("Awaiting GC " + n);
+        for(int i = 0 ; i < n ; i++) {
+            Thread.sleep(1000);
+            System.gc();
+        }
+    }
 
     /**
      * Usage: java -cp ... AllTests file.jar [-l] [--print-cases]
@@ -186,20 +198,28 @@ public static void main(String[] args) throws Exception {
 
         boolean runNamedTests = false;
         boolean printTestList = false;
+        int doGc = 0;
+        boolean doHeapDump = false;
         HashSet<String> namedTests = new HashSet<String>();
 
         for(int i = 1 ; i < args.length ; i++) {
             if (args[i].equals("-l") || args[i].equals("--print-cases"))
-              printTestList = true;
+                printTestList = true;
 
             else if (args[i].equalsIgnoreCase("--enable-debug-tests"))
                 enableDebugTests = true;
 
+            else if (args[i].equals("--hprof"))
+                doHeapDump = true;
+
+            else if (args[i].startsWith("--gc="))
+                doGc = Integer.parseInt(args[i].substring(5));
+
             else if(runNamedTests)
-              namedTests.add(args[i]);
+                namedTests.add(args[i]);
 
             else if (args[i].equals("-n"))
-              runNamedTests = true;
+                runNamedTests = true;
 
             else
               usage("Unrecognized option");
@@ -215,11 +235,27 @@ else if (args[i].equals("-n"))
 
         TestSuite suite = suite(namedTests);
 
+        System.out.println("Java " + System.getProperty("java.version"));
         System.out.println("Running " + (runNamedTests ? "named" : "all") +
                            " tests in '" + jarFile + "'");
         System.out.println("Found " + suite.testCount() + " test classes.");
         TestResult res = junit.textui.TestRunner.run(suite);
         System.out.println("Finished running tests in '" + jarFile + "'");
-        System.exit(res.wasSuccessful() ? 0 : 1);
+
+        int exitCode = res.wasSuccessful() ? 0 : 1;
+        if(doGc > 0) {
+            suite = null;
+            res = null;
+            tryGc(doGc);
+        }
+
+        if(doHeapDump) {
+            String pid = ManagementFactory.getRuntimeMXBean().getName().split("@")[0];
+            String file = "clusterj-test." + pid + ".hprof";
+            System.out.println("Creating heap dump: " + file);
+            ManagementFactory.getPlatformMXBean(HotSpotDiagnosticMXBean.class).dumpHeap(file, true);
+        }
+
+        System.exit(exitCode);
     }
 }

storage/ndb/clusterj/clusterj-test/src/main/java/testsuite/clusterj/BlobInstanceTest.java

@@ -0,0 +1,136 @@
+
+/*
+   Copyright (c) 2010, 2024, Oracle and/or its affiliates.
+   Use is subject to license terms.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License, version 2.0,
+   as published by the Free Software Foundation.
+
+   This program is designed to work with certain software (including
+   but not limited to OpenSSL) that is licensed under separate terms,
+   as designated in a particular file or component or in included license
+   documentation.  The authors of MySQL hereby grant you an additional
+   permission to link the program and your derivative works with the
+   separately licensed software that they have either included with
+   the program or referenced in the documentation.
+
+   This program 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.0, for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+*/
+
+package testsuite.clusterj;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import com.mysql.clusterj.Session;
+
+import testsuite.clusterj.model.BlobTypes;
+
+public class BlobInstanceTest extends AbstractClusterJModelTest {
+
+    @Override
+    public void localSetUp() {
+        createSessionFactory();
+        addTearDownClasses(BlobTypes.class);
+      }
+
+    static final int ITERATIONS = 500;
+
+    BlobTypes[] instances = null;
+
+    /* The purpose of this test is to induce leaking of DirectByteBuffers
+    */
+
+    public void test() {
+        instances = new BlobTypes[ITERATIONS];
+        create();
+        save();
+        update();
+        failOnError();
+        instances = null;
+    }
+
+    private void create() {
+        for(int i = 0 ; i < ITERATIONS ; i++)
+            instances[i] = create(i);
+    }
+
+    private void save() {
+        for(int i = 0 ; i < ITERATIONS ; i++)
+            instances[i] = save(instances[i]);
+    }
+
+    private void update() {
+        for(int i = 0 ; i < ITERATIONS ; i++)
+            update(instances[i]);
+    }
+
+    private BlobTypes create(int id) {
+        final Session s = sessionFactory.getSession();
+        try {
+            BlobTypes b = s.newInstance(BlobTypes.class);
+            b.setId(id);
+            b.setId_null_none(id);
+            b.setId_null_hash(id);
+            b.setBlobbytes(getBlobBytes(4600 + id));
+            return b;
+        } finally {
+            s.close();
+        }
+    }
+
+    private BlobTypes save(BlobTypes instance) {
+        final Session s = sessionFactory.getSession();
+        final int id = instance.getId();
+        try {
+            BlobTypes b = s.newInstance(BlobTypes.class);
+            b.setId(id);
+            b.setId_null_none(id+1000);
+            b.setId_null_hash(id);
+            b.setBlobbytes(instance.getBlobbytes());
+            return b;
+        } finally {
+            s.close();
+        }
+    }
+
+    private void update(BlobTypes instance) {
+        final Session s = sessionFactory.getSession();
+        final int id = instance.getId();
+        try {
+            BlobTypes b = s.newInstance(BlobTypes.class);
+            b.setId(id);
+            b.setId_null_none(instance.getId_null_none());
+            b.setId_null_hash(id+2000);
+            b.setBlobbytes(instance.getBlobbytes());
+        } finally {
+            s.close();
+        }
+    }
+
+
+    /** Create a new byte[] of the specified size containing a pattern
+     * of bytes in which each byte is the unsigned value of the index
+     * modulo 256. This pattern is easy to test.
+     * @param size the length of the returned byte[]
+     * @return the byte[] filled with the pattern
+     */
+    protected byte[] getBlobBytes(int size) {
+        byte[] result = new byte[size];
+        for (int i = 0; i < size; ++i) {
+            result[i] = (byte)((i % 256) - 128);
+        }
+        return result;
+    }
+}

storage/ndb/clusterj/clusterj-tie/src/main/java/com/mysql/clusterj/tie/FixedByteBufferPoolImpl.java

@@ -100,7 +100,7 @@ public FixedByteBufferPoolImpl(int bufferSize, String name) {
         this.bufferSize = bufferSize;
         this.name = name;
         this.pool = new ConcurrentLinkedQueue<ByteBuffer>();
-        logger.info("FixedByteBufferPoolImpl<init> for " + name + " bufferSize " + bufferSize);
+        logger.debug("FixedByteBufferPoolImpl<init> for " + name + " bufferSize " + bufferSize);
     }
 
     /** Borrow a buffer from the pool. If none in the pool, create a new one. */

storage/ndb/clusterj/clusterj-tie/src/main/java/com/mysql/clusterj/tie/Utility.java

@@ -2460,7 +2460,7 @@ private static CharsetConverter addCollation(int collation) {
         }
         for (int peer: collations) {
             // for each collation that shares the same charset name, set the charset converter
-            logger.info("Adding charset converter " + charsetName + " for collation " + peer);
+            logger.debug("Adding charset converter " + charsetName + " for collation " + peer);
             charsetConverters[peer] = charsetConverter;
         }
         return charsetConverter;

storage/ndb/clusterj/clusterj-unit/src/main/java/junit/textui/TestRunner.java

@@ -57,6 +57,9 @@ static public TestResult run(Test test) {
         } else if(result.failures.size() > 0) {
             System.out.println(resultPrinter.toString());
             System.out.println("\nSome tests failed.");
+        } else if(result.failures.size() + result.throwables.size() > 0) {
+            System.out.println(resultPrinter.toString());
+            System.out.println("\nAll tests failed.");
         } else {
             System.out.println("No tests run.");
         }

storage/ndb/test/ndbapi/testClusterJ.cpp

@@ -124,18 +124,10 @@ bool write_properties(const char *connStr, const char *mysqlStr) {
   if (!fp) return false;
   fprintf(fp,
           "com.mysql.clusterj.connectstring=%s\n"
-          "com.mysql.clusterj.connect.retries=4\n"
-          "com.mysql.clusterj.connect.delay=5\n"
-          "com.mysql.clusterj.connect.verbose=1\n"
-          "com.mysql.clusterj.connect.timeout.before=30\n"
-          "com.mysql.clusterj.connect.timeout.after=20\n"
           "com.mysql.clusterj.jdbc.url=jdbc:mysql://%s/test\n"
           "com.mysql.clusterj.jdbc.driver=com.mysql.cj.jdbc.Driver\n"
           "com.mysql.clusterj.jdbc.username=root\n"
           "com.mysql.clusterj.jdbc.password=\n"
-          "com.mysql.clusterj.username=\n"
-          "com.mysql.clusterj.password=\n"
-          "com.mysql.clusterj.database=test\n"
           "com.mysql.clusterj.max.transactions=1024\n",
           connStr, mysqlStr);
   fclose(fp);
@@ -201,6 +193,8 @@ int run_tests(int argc, char **argv) {
   args.add("-Djava.library.path=", ndbClientDir.c_str());
   args.add("-Dclusterj.properties=", paths.propsFile().c_str());
   args.add("-Duser.timezone=GMT-3");
+  args.add("-ea");
+  if (getenv("LOG_GC")) args.add("-Xlog:gc=trace:file=clusterj-%p-gc.log");
   args.add2("-cp", classpath.c_str());
   args.add("testsuite.clusterj.AllTests");
   args.add(clusterjTestJar.c_str());