rocksdb/java/rocksjni/options_util.cc
Alan Paxton b2fe14817e java API - load block based table config (#10826)
Summary:
Closes https://github.com/facebook/rocksdb/issues/5297

The BlockBasedTableConfig (or more generally, the TableFormatConfig) of ColumnFamilyOptions, isn't being constructed when column family options are loaded. This happens in `OptionsUtil` which implements the loading.

In `OptionsUtil` we add the method `private native static TableFormatConfig readTableFormatConfig(final long nativeHandle_)` which defers to a JNI method which creates a `TableFormatConfig` (specifically a `BlockBasedTableConfig`) for the supplied `ColumnFamilyOptions`, by copying the table format attached to the C++ column family options. A new Java constructor for `BlockBasedTableConfig` is implemented which is called from C++ with the parameters retrieved from the table format, and then returned to the calling `readTableFormatConfig`.

At the Java side in `OptionsUtil`, the new `TableFormatConfig` is added as the `tableFormatConfig_` field of the `ColumnFamilyOptions`.

To support this, the new class `BlockBasedTableOptionsJni` and associated support methods are added to 'portal.h'.

`BloomFilter.java` has a constructor and field added so that the filter in use can be read back and inspected.

`FilterPolicyType.java` implements an enum (shadowed in C++) to support transfer of filter policy information back to Java from being read at the C++ side.

 Tests written to cover the block based table config, and cleaned up and generalised a bit as some of the methods on OptionsUtil weren't tested; and these had their own unique JNI method variants which in turn were never exercised in test.

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

Reviewed By: ajkr

Differential Revision: D50136247

Pulled By: jowlyzhang

fbshipit-source-id: 39387448147abc574e99f43979d89b0900e5f81d
2023-10-12 09:39:01 -07:00

188 lines
6.5 KiB
C++

// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
// This source code is licensed under both the GPLv2 (found in the
// COPYING file in the root directory) and Apache 2.0 License
// (found in the LICENSE.Apache file in the root directory).
//
// This file implements the "bridge" between Java and C++ and enables
// calling C++ ROCKSDB_NAMESPACE::OptionsUtil methods from Java side.
#include "rocksdb/utilities/options_util.h"
#include <jni.h>
#include <string>
#include "include/org_rocksdb_OptionsUtil.h"
#include "rocksdb/db.h"
#include "rocksdb/env.h"
#include "rocksjni/portal.h"
void build_column_family_descriptor_list(
JNIEnv* env, jobject jcfds,
std::vector<ROCKSDB_NAMESPACE::ColumnFamilyDescriptor>& cf_descs) {
jmethodID add_mid = ROCKSDB_NAMESPACE::ListJni::getListAddMethodId(env);
if (add_mid == nullptr) {
// exception occurred accessing method
return;
}
// Column family descriptor
for (ROCKSDB_NAMESPACE::ColumnFamilyDescriptor& cfd : cf_descs) {
// Construct a ColumnFamilyDescriptor java object
jobject jcfd =
ROCKSDB_NAMESPACE::ColumnFamilyDescriptorJni::construct(env, &cfd);
if (env->ExceptionCheck()) {
// exception occurred constructing object
if (jcfd != nullptr) {
env->DeleteLocalRef(jcfd);
}
return;
}
// Add the object to java list.
jboolean rs = env->CallBooleanMethod(jcfds, add_mid, jcfd);
if (env->ExceptionCheck() || rs == JNI_FALSE) {
// exception occurred calling method, or could not add
if (jcfd != nullptr) {
env->DeleteLocalRef(jcfd);
}
return;
}
}
}
/*
* Class: org_rocksdb_OptionsUtil
* Method: loadLatestOptions
* Signature: (JLjava/lang/String;JLjava/util/List;)V
*/
void Java_org_rocksdb_OptionsUtil_loadLatestOptions(
JNIEnv* env, jclass /*jcls*/, jlong cfg_handle, jstring jdbpath,
jlong jdb_opts_handle, jobject jcfds) {
jboolean has_exception = JNI_FALSE;
auto db_path =
ROCKSDB_NAMESPACE::JniUtil::copyStdString(env, jdbpath, &has_exception);
if (has_exception == JNI_TRUE) {
// exception occurred
return;
}
std::vector<ROCKSDB_NAMESPACE::ColumnFamilyDescriptor> cf_descs;
auto* config_options =
reinterpret_cast<ROCKSDB_NAMESPACE::ConfigOptions*>(cfg_handle);
auto* db_options =
reinterpret_cast<ROCKSDB_NAMESPACE::DBOptions*>(jdb_opts_handle);
ROCKSDB_NAMESPACE::Status s = ROCKSDB_NAMESPACE::LoadLatestOptions(
*config_options, db_path, db_options, &cf_descs);
if (!s.ok()) {
// error, raise an exception
ROCKSDB_NAMESPACE::RocksDBExceptionJni::ThrowNew(env, s);
} else {
build_column_family_descriptor_list(env, jcfds, cf_descs);
}
}
/*
* Class: org_rocksdb_OptionsUtil
* Method: loadOptionsFromFile
* Signature: (JLjava/lang/String;JLjava/util/List;)V
*/
void Java_org_rocksdb_OptionsUtil_loadOptionsFromFile(
JNIEnv* env, jclass /*jcls*/, jlong cfg_handle, jstring jopts_file_name,
jlong jdb_opts_handle, jobject jcfds) {
jboolean has_exception = JNI_FALSE;
auto opts_file_name = ROCKSDB_NAMESPACE::JniUtil::copyStdString(
env, jopts_file_name, &has_exception);
if (has_exception == JNI_TRUE) {
// exception occurred
return;
}
std::vector<ROCKSDB_NAMESPACE::ColumnFamilyDescriptor> cf_descs;
auto* config_options =
reinterpret_cast<ROCKSDB_NAMESPACE::ConfigOptions*>(cfg_handle);
auto* db_options =
reinterpret_cast<ROCKSDB_NAMESPACE::DBOptions*>(jdb_opts_handle);
ROCKSDB_NAMESPACE::Status s = ROCKSDB_NAMESPACE::LoadOptionsFromFile(
*config_options, opts_file_name, db_options, &cf_descs);
if (!s.ok()) {
// error, raise an exception
ROCKSDB_NAMESPACE::RocksDBExceptionJni::ThrowNew(env, s);
} else {
build_column_family_descriptor_list(env, jcfds, cf_descs);
}
}
/*
* Class: org_rocksdb_OptionsUtil
* Method: getLatestOptionsFileName
* Signature: (Ljava/lang/String;J)Ljava/lang/String;
*/
jstring Java_org_rocksdb_OptionsUtil_getLatestOptionsFileName(
JNIEnv* env, jclass /*jcls*/, jstring jdbpath, jlong jenv_handle) {
jboolean has_exception = JNI_FALSE;
auto db_path =
ROCKSDB_NAMESPACE::JniUtil::copyStdString(env, jdbpath, &has_exception);
if (has_exception == JNI_TRUE) {
// exception occurred
return nullptr;
}
std::string options_file_name;
ROCKSDB_NAMESPACE::Status s = ROCKSDB_NAMESPACE::GetLatestOptionsFileName(
db_path, reinterpret_cast<ROCKSDB_NAMESPACE::Env*>(jenv_handle),
&options_file_name);
if (!s.ok()) {
// error, raise an exception
ROCKSDB_NAMESPACE::RocksDBExceptionJni::ThrowNew(env, s);
return nullptr;
} else {
return env->NewStringUTF(options_file_name.c_str());
}
}
/*
* Class: org_rocksdb_OptionsUtil
* Method: readTableFormatConfig
* Signature: (J)Lorg/rocksdb/TableFormatConfig;
*/
jobject Java_org_rocksdb_OptionsUtil_readTableFormatConfig(JNIEnv* env, jclass,
jlong jcf_options) {
if (jcf_options == 0) {
env->ThrowNew(
ROCKSDB_NAMESPACE::IllegalArgumentExceptionJni::getJClass(env),
"Null column family options handle supplied to "
"readNewTableFormatConfig");
return nullptr;
}
auto* cf_options =
reinterpret_cast<ROCKSDB_NAMESPACE::ColumnFamilyOptions*>(jcf_options);
auto* table_factory = cf_options->table_factory.get();
if (table_factory == nullptr) {
env->ThrowNew(
ROCKSDB_NAMESPACE::IllegalArgumentExceptionJni::getJClass(env),
"Column family options supplied to readNewTableFormatConfig has no "
"table options");
return nullptr;
}
if (strcmp(ROCKSDB_NAMESPACE::TableFactory::kBlockBasedTableName(),
table_factory->Name()) == 0) {
auto* table_factory_options =
table_factory->GetOptions<ROCKSDB_NAMESPACE::BlockBasedTableOptions>();
if (table_factory_options == nullptr) {
ROCKSDB_NAMESPACE::IllegalArgumentExceptionJni::ThrowNew(
env, std::string("Null table format options supplied to "
"readNewTableFormatConfig() ") +
table_factory->Name());
return nullptr;
}
return ROCKSDB_NAMESPACE::BlockBasedTableOptionsJni::construct(
env, table_factory_options);
} else {
ROCKSDB_NAMESPACE::IllegalArgumentExceptionJni::ThrowNew(
env, std::string("readNewTableFormatConfig() is not implemented for "
"this table format: ") +
table_factory->Name());
return nullptr;
}
}