Add deletion-triggered compaction to RocksJava (#12028)

Summary: Pull Request resolved: https://github.com/facebook/rocksdb/pull/12028

Reviewed By: akankshamahajan15

Differential Revision: D52264983

Pulled By: ajkr

fbshipit-source-id: 02d08015b4bffac06d889dc1be50a51d03f891b3

java/CMakeLists.txt

@@ -77,6 +77,7 @@ set(JNI_NATIVE_SOURCES
         rocksjni/table.cc
         rocksjni/table_filter.cc
         rocksjni/table_filter_jnicallback.cc
+        rocksjni/table_properties_collector_factory.cc
         rocksjni/testable_event_listener.cc
         rocksjni/thread_status.cc
         rocksjni/trace_writer.cc
@@ -257,6 +258,7 @@ set(JAVA_MAIN_CLASSES
   src/main/java/org/rocksdb/TableFileDeletionInfo.java
   src/main/java/org/rocksdb/TableFilter.java
   src/main/java/org/rocksdb/TableProperties.java
+  src/main/java/org/rocksdb/TablePropertiesCollectorFactory.java
   src/main/java/org/rocksdb/TableFormatConfig.java
   src/main/java/org/rocksdb/ThreadType.java
   src/main/java/org/rocksdb/ThreadStatus.java

java/rocksjni/options.cc

@@ -37,6 +37,7 @@
 #include "rocksjni/portal.h"
 #include "rocksjni/statisticsjni.h"
 #include "rocksjni/table_filter_jnicallback.h"
+#include "rocksjni/table_properties_collector_factory.h"
 #include "utilities/merge_operators.h"
 
 /*
@@ -3927,6 +3928,62 @@ jint Java_org_rocksdb_Options_memtableMaxRangeDeletions(JNIEnv*, jobject,
   return static_cast<jint>(opts->memtable_max_range_deletions);
 }
 
+/*
+ * Class:     org_rocksdb_Options
+ * Method:    tablePropertiesCollectorFactory
+ * Signature: (J)[J
+ */
+jlongArray Java_org_rocksdb_Options_tablePropertiesCollectorFactory(
+    JNIEnv* env, jclass, jlong jhandle) {
+  auto* opt = reinterpret_cast<ROCKSDB_NAMESPACE::Options*>(jhandle);
+  const size_t size = opt->table_properties_collector_factories.size();
+  jlongArray retVal = env->NewLongArray(static_cast<jsize>(size));
+  if (retVal == nullptr) {
+    // exception thrown: OutOfMemoryError
+    return nullptr;
+  }
+  jlong* buf = env->GetLongArrayElements(retVal, NULL);
+  if (buf == nullptr) {
+    // exception thrown: OutOfMemoryError
+    return nullptr;
+  }
+
+  for (size_t i = 0; i < size; i++) {
+    auto* wrapper = new TablePropertiesCollectorFactoriesJniWrapper();
+    wrapper->table_properties_collector_factories =
+        opt->table_properties_collector_factories[i];
+    buf[i] = GET_CPLUSPLUS_POINTER(wrapper);
+  }
+  env->ReleaseLongArrayElements(retVal, buf, 0);
+  return retVal;
+}
+
+/*
+ * Class:     org_rocksdb_Options
+ * Method:    setTablePropertiesCollectorFactory
+ * Signature: (J[J)V
+ */
+void Java_org_rocksdb_Options_setTablePropertiesCollectorFactory(
+    JNIEnv* env, jclass, jlong jhandle, jlongArray j_factory_handles) {
+  auto* opt = reinterpret_cast<ROCKSDB_NAMESPACE::Options*>(jhandle);
+  const jsize size = env->GetArrayLength(j_factory_handles);
+
+  jlong* buf = env->GetLongArrayElements(j_factory_handles, NULL);
+  if (buf == nullptr) {
+    // exception thrown: OutOfMemoryError
+    return;
+  }
+
+  opt->table_properties_collector_factories.clear();
+  for (jsize i = 0; i < size; i++) {
+    auto* wrapper =
+        reinterpret_cast<TablePropertiesCollectorFactoriesJniWrapper*>(buf[i]);
+    opt->table_properties_collector_factories.emplace_back(
+        wrapper->table_properties_collector_factories);
+  }
+  env->ReleaseLongArrayElements(j_factory_handles, buf, JNI_ABORT);
+}
+
 //////////////////////////////////////////////////////////////////////////////
 // ROCKSDB_NAMESPACE::ColumnFamilyOptions
 

java/rocksjni/table_properties_collector_factory.cc

@@ -0,0 +1,37 @@
+//
+// Created by rhubner on 23-Oct-23.
+//
+
+#include "java/rocksjni/table_properties_collector_factory.h"
+
+#include "java/include/org_rocksdb_TablePropertiesCollectorFactory.h"
+#include "java/rocksjni/cplusplus_to_java_convert.h"
+#include "rocksdb/db.h"
+#include "rocksdb/utilities/table_properties_collectors.h"
+
+/*
+ * Class:     org_rocksdb_TablePropertiesCollectorFactory
+ * Method:    newCompactOnDeletionCollectorFactory
+ * Signature: (JJD)J
+ */
+jlong Java_org_rocksdb_TablePropertiesCollectorFactory_newCompactOnDeletionCollectorFactory(
+    JNIEnv *, jclass, jlong sliding_window_size, jlong deletion_trigger,
+    jdouble deletion_ratio) {
+  auto *wrapper = new TablePropertiesCollectorFactoriesJniWrapper();
+  wrapper->table_properties_collector_factories =
+      ROCKSDB_NAMESPACE::NewCompactOnDeletionCollectorFactory(
+          sliding_window_size, deletion_trigger, deletion_ratio);
+  return GET_CPLUSPLUS_POINTER(wrapper);
+}
+
+/*
+ * Class:     org_rocksdb_TablePropertiesCollectorFactory
+ * Method:    deleteCompactOnDeletionCollectorFactory
+ * Signature: (J)J
+ */
+void Java_org_rocksdb_TablePropertiesCollectorFactory_deleteCompactOnDeletionCollectorFactory(
+    JNIEnv *, jclass, jlong jhandle) {
+  auto instance =
+      reinterpret_cast<TablePropertiesCollectorFactoriesJniWrapper *>(jhandle);
+  delete instance;
+}

java/rocksjni/table_properties_collector_factory.h

@@ -0,0 +1,15 @@
+//
+// Created by rhubner on 24-Oct-23.
+//
+
+#include "rocksdb/table_properties.h"
+#include "rocksdb/utilities/table_properties_collectors.h"
+
+#ifndef ROCKSDB_TABLE_PROPERTIES_COLLECTOR_FACTORY_H
+#define ROCKSDB_TABLE_PROPERTIES_COLLECTOR_FACTORY_H
+
+struct TablePropertiesCollectorFactoriesJniWrapper {
+  std::shared_ptr<rocksdb::TablePropertiesCollectorFactory>
+      table_properties_collector_factories;
+};
+#endif  // ROCKSDB_TABLE_PROPERTIES_COLLECTOR_FACTORY_H

java/src/main/java/org/rocksdb/Options.java

@@ -7,6 +7,7 @@ package org.rocksdb;
 
 import java.nio.file.Paths;
 import java.util.*;
+import java.util.stream.Collectors;
 
 /**
  * Options to control the behavior of a database.  It will be used
@@ -2123,6 +2124,35 @@ public class Options extends RocksObject
   // END options for blobs (integrated BlobDB)
   //
 
+  /**
+   * Return copy of TablePropertiesCollectorFactory list. Modifying this list will not change
+   * underlying options C++ object. {@link #setTablePropertiesCollectorFactory(List)
+   * setTablePropertiesCollectorFactory} must be called to propagate changes. All instance must be
+   * properly closed to prevent memory leaks.
+   * @return copy of TablePropertiesCollectorFactory list.
+   */
+  public List<TablePropertiesCollectorFactory> tablePropertiesCollectorFactory() {
+    long[] factoryHandlers = tablePropertiesCollectorFactory(nativeHandle_);
+
+    return Arrays.stream(factoryHandlers)
+        .mapToObj(factoryHandle -> TablePropertiesCollectorFactory.newWrapper(factoryHandle))
+        .collect(Collectors.toList());
+  }
+
+  /**
+   * Set TablePropertiesCollectorFactory in underlying C++ object.
+   * This method create its own copy of the list. Caller is responsible for
+   * closing all the instances in the list.
+   * @param factories
+   */
+  public void setTablePropertiesCollectorFactory(List<TablePropertiesCollectorFactory> factories) {
+    long[] factoryHandlers = new long[factories.size()];
+    for (int i = 0; i < factoryHandlers.length; i++) {
+      factoryHandlers[i] = factories.get(i).getNativeHandle();
+    }
+    setTablePropertiesCollectorFactory(nativeHandle_, factoryHandlers);
+  }
+
   private static long newOptionsInstance() {
     RocksDB.loadLibrary();
     return newOptions();
@@ -2563,6 +2593,9 @@ public class Options extends RocksObject
   private native void setPrepopulateBlobCache(
       final long nativeHandle_, final byte prepopulateBlobCache);
   private native byte prepopulateBlobCache(final long nativeHandle_);
+  private static native long[] tablePropertiesCollectorFactory(long nativeHandle);
+  private static native void setTablePropertiesCollectorFactory(
+      long nativeHandle, long[] factoryHandlers);
 
   // instance variables
   // NOTE: If you add new member variables, please update the copy constructor above!

java/src/main/java/org/rocksdb/TablePropertiesCollectorFactory.java

@@ -0,0 +1,38 @@
+package org.rocksdb;
+
+public abstract class TablePropertiesCollectorFactory extends RocksObject {
+  private TablePropertiesCollectorFactory(final long nativeHandle) {
+    super(nativeHandle);
+  }
+
+  public static TablePropertiesCollectorFactory NewCompactOnDeletionCollectorFactory(
+      final long sliding_window_size, final long deletion_trigger, final double deletion_ratio) {
+    long handle =
+        newCompactOnDeletionCollectorFactory(sliding_window_size, deletion_trigger, deletion_ratio);
+    return new TablePropertiesCollectorFactory(handle) {
+      @Override
+      protected void disposeInternal(long handle) {
+        TablePropertiesCollectorFactory.deleteCompactOnDeletionCollectorFactory(handle);
+      }
+    };
+  }
+
+  /**
+   * Internal API. Do not use.
+   * @param nativeHandle
+   * @return
+   */
+  static TablePropertiesCollectorFactory newWrapper(final long nativeHandle) {
+    return new TablePropertiesCollectorFactory(nativeHandle) {
+      @Override
+      protected void disposeInternal(long handle) {
+        TablePropertiesCollectorFactory.deleteCompactOnDeletionCollectorFactory(handle);
+      }
+    };
+  }
+
+  private static native long newCompactOnDeletionCollectorFactory(
+      final long slidingWindowSize, final long deletionTrigger, final double deletionRatio);
+
+  private static native void deleteCompactOnDeletionCollectorFactory(final long handle);
+}

java/src/test/java/org/rocksdb/OptionsTest.java

@@ -1496,4 +1496,20 @@ public class OptionsTest {
       assertEquals(0, listeners2.size());
     }
   }
+  @Test
+  public void tablePropertiesCollectorFactory() {
+    try (final Options options = new Options()) {
+      try (TablePropertiesCollectorFactory collectorFactory =
+               TablePropertiesCollectorFactory.NewCompactOnDeletionCollectorFactory(10, 10, 1.0)) {
+        List<TablePropertiesCollectorFactory> factories = Arrays.asList(collectorFactory);
+        options.setTablePropertiesCollectorFactory(factories);
+      }
+      List<TablePropertiesCollectorFactory> factories = options.tablePropertiesCollectorFactory();
+      try {
+        assertThat(factories).hasSize(1);
+      } finally {
+        factories.stream().forEach(TablePropertiesCollectorFactory::close);
+      }
+    }
+  }
 }

src.mk

@@ -705,6 +705,7 @@ JNI_NATIVE_SOURCES =                                          \
   java/rocksjni/table.cc                                      \
   java/rocksjni/table_filter.cc                               \
   java/rocksjni/table_filter_jnicallback.cc                   \
+  java/rocksjni/table_properties_collector_factory.cc         \
   java/rocksjni/thread_status.cc                              \
   java/rocksjni/trace_writer.cc                               \
   java/rocksjni/trace_writer_jnicallback.cc                   \