You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by GitBox <gi...@apache.org> on 2022/06/09 03:17:02 UTC

[GitHub] [incubator-doris] zhangstar333 commented on a diff in pull request #9930: [Vectorized][UDF] support java-udaf

zhangstar333 commented on code in PR #9930:
URL: https://github.com/apache/incubator-doris/pull/9930#discussion_r893032637


##########
be/src/vec/aggregate_functions/aggregate_function_java_udaf.h:
##########
@@ -0,0 +1,361 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#pragma once
+
+#ifdef LIBJVM
+
+#include <jni.h>
+#include <unistd.h>
+
+#include <cstdint>
+#include <memory>
+
+#include "common/status.h"
+#include "gen_cpp/Exprs_types.h"
+#include "runtime/user_function_cache.h"
+#include "util/jni-util.h"
+#include "vec/aggregate_functions/aggregate_function.h"
+#include "vec/columns/column_string.h"
+#include "vec/common/exception.h"
+#include "vec/common/string_ref.h"
+#include "vec/core/block.h"
+#include "vec/core/column_numbers.h"
+#include "vec/core/field.h"
+#include "vec/core/types.h"
+#include "vec/data_types/data_type_string.h"
+#include "vec/io/io_helper.h"
+
+namespace doris::vectorized {
+
+const char* UDAF_EXECUTOR_CLASS = "org/apache/doris/udf/UdafExecutor";
+const char* UDAF_EXECUTOR_CTOR_SIGNATURE = "([B)V";
+const char* UDAF_EXECUTOR_CLOSE_SIGNATURE = "()V";
+const char* UDAF_EXECUTOR_ADD_SIGNATURE = "(JJ)V";
+const char* UDAF_EXECUTOR_SERIALIZE_SIGNATURE = "(Ljava/lang/Object;)V";
+const char* UDAF_EXECUTOR_MERGE_SIGNATURE = "(Ljava/lang/Object;)V";
+const char* UDAF_EXECUTOR_RESULT_SIGNATURE = "(J)Z";
+
+struct AggregateJavaUdafData {
+public:
+    AggregateJavaUdafData() = default;
+    AggregateJavaUdafData(int64_t num_args) {
+        argument_size = num_args;
+        first_init = true;
+        input_values_buffer_ptr.reset(new int64_t[num_args]);
+        input_nulls_buffer_ptr.reset(new int64_t[num_args]);
+        input_offsets_ptrs.reset(new int64_t[num_args]);
+        output_value_buffer.reset(new int64_t);
+        output_null_value.reset(new int64_t);
+        output_offsets_ptr.reset(new int64_t);
+        output_intermediate_state_ptr.reset(new int64_t);
+    }
+
+    ~AggregateJavaUdafData() {
+        JNIEnv* env;
+        Status status;
+        RETURN_IF_STATUS_ERROR(status, JniUtil::GetJNIEnv(&env));
+        env->CallNonvirtualVoidMethod(executor_obj, executor_cl, executor_close_id);
+        RETURN_IF_STATUS_ERROR(status, JniUtil::GetJniExceptionMsg(env));
+        env->DeleteGlobalRef(executor_obj);
+    }
+
+    Status init_udaf(const TFunction& fn) {
+        if (first_init) {
+            JNIEnv* env = nullptr;
+            RETURN_NOT_OK_STATUS_WITH_WARN(JniUtil::GetJNIEnv(&env),
+                                           "Java-Udaf init_udaf function");
+            RETURN_IF_ERROR(JniUtil::GetGlobalClassRef(env, UDAF_EXECUTOR_CLASS, &executor_cl));
+            RETURN_NOT_OK_STATUS_WITH_WARN(register_func_id(env),
+                                           "Java-Udaf register_func_id function");
+
+            // Add a scoped cleanup jni reference object. This cleans up local refs made below.
+            JniLocalFrame jni_frame;
+            {
+                std::string local_location;
+                auto function_cache = UserFunctionCache::instance();
+                RETURN_IF_ERROR(function_cache->get_jarpath(fn.id, fn.hdfs_location, fn.checksum,
+                                                            &local_location));
+                TJavaUdfExecutorCtorParams ctor_params;
+                ctor_params.__set_fn(fn);
+                ctor_params.__set_location(local_location);
+                ctor_params.__set_input_offsets_ptrs((int64_t)input_offsets_ptrs.get());
+                ctor_params.__set_input_buffer_ptrs((int64_t)input_values_buffer_ptr.get());
+                ctor_params.__set_input_nulls_ptrs((int64_t)input_nulls_buffer_ptr.get());
+                ctor_params.__set_output_buffer_ptr((int64_t)output_value_buffer.get());
+
+                ctor_params.__set_output_null_ptr((int64_t)output_null_value.get());
+                ctor_params.__set_output_offsets_ptr((int64_t)output_offsets_ptr.get());
+                ctor_params.__set_output_intermediate_state_ptr(
+                        (int64_t)output_intermediate_state_ptr.get());
+
+                jbyteArray ctor_params_bytes;
+
+                // Pushed frame will be popped when jni_frame goes out-of-scope.
+                RETURN_IF_ERROR(jni_frame.push(env));
+                RETURN_IF_ERROR(SerializeThriftMsg(env, &ctor_params, &ctor_params_bytes));
+                executor_obj = env->NewObject(executor_cl, executor_ctor_id, ctor_params_bytes);
+            }
+            RETURN_ERROR_IF_EXC(env);
+            RETURN_IF_ERROR(JniUtil::LocalToGlobalRef(env, executor_obj, &executor_obj));
+            first_init = false;
+        }
+        return Status::OK();
+    }
+
+    Status add(const IColumn** columns, size_t row_num_start, size_t row_num_end,
+               const DataTypes& argument_types) {
+        JNIEnv* env = nullptr;
+        RETURN_NOT_OK_STATUS_WITH_WARN(JniUtil::GetJNIEnv(&env), "Java-Udaf add function");
+        for (int arg_idx = 0; arg_idx < argument_size; ++arg_idx) {
+            auto data_col = columns[arg_idx];
+            if (auto* nullable = check_and_get_column<const ColumnNullable>(*columns[arg_idx])) {
+                data_col = nullable->get_nested_column_ptr();
+                auto null_col = check_and_get_column<ColumnVector<UInt8>>(
+                        nullable->get_null_map_column_ptr());
+                input_nulls_buffer_ptr.get()[arg_idx] =
+                        reinterpret_cast<int64_t>(null_col->get_data().data());
+            } else {
+                input_nulls_buffer_ptr.get()[arg_idx] = -1;
+            }
+            if (data_col->is_column_string()) {
+                const ColumnString* str_col = check_and_get_column<ColumnString>(data_col);
+                input_values_buffer_ptr.get()[arg_idx] =
+                        reinterpret_cast<int64_t>(str_col->get_chars().data());
+                input_offsets_ptrs.get()[arg_idx] =
+                        reinterpret_cast<int64_t>(str_col->get_offsets().data());
+            } else if (data_col->is_numeric() || data_col->is_column_decimal()) {
+                input_values_buffer_ptr.get()[arg_idx] =
+                        reinterpret_cast<int64_t>(data_col->get_raw_data().data);
+            } else {
+                return Status::InvalidArgument(
+                        strings::Substitute("Java UDAF doesn't support type is $0 now !",
+                                            argument_types[arg_idx]->get_name()));
+            }
+        }
+        env->CallNonvirtualVoidMethod(executor_obj, executor_cl, executor_add_id, row_num_start,
+                                      row_num_end);
+        return Status::OK();
+    }
+
+    Status merge(const AggregateJavaUdafData& rhs) {
+        if (rhs.first_init) {
+            return Status::OK();
+        }
+        JNIEnv* env = nullptr;
+        RETURN_NOT_OK_STATUS_WITH_WARN(JniUtil::GetJNIEnv(&env), "Java-Udaf merge function");
+        serialize_data = rhs.serialize_data;
+        long len = serialize_data.length();
+        jobject data = env->NewDirectByteBuffer(serialize_data.data(), len);
+        env->CallNonvirtualVoidMethod(executor_obj, executor_cl, executor_merge_id, data);
+        return Status::OK();
+    }
+
+    Status write(BufferWritable& buf) {
+        write_binary(first_init, buf);
+        JNIEnv* env = nullptr;
+        RETURN_NOT_OK_STATUS_WITH_WARN(JniUtil::GetJNIEnv(&env), "Java-Udaf write function");
+        jlong len = env->GetLongField(executor_obj, serialize_len_id);
+        serialize_data.resize(len);
+        jobject data = env->NewDirectByteBuffer(serialize_data.data(), len);
+        env->CallNonvirtualVoidMethod(executor_obj, executor_cl, executor_serialize_id, data);
+        write_binary(serialize_data, buf);
+        return Status::OK();
+    }
+
+    void read(BufferReadable& buf) {
+        read_binary(first_init, buf);
+        read_binary(serialize_data, buf);
+    }
+
+    Status get(IColumn& to, const DataTypePtr& result_type) const {
+        to.insert_default();
+        JNIEnv* env = nullptr;
+        RETURN_NOT_OK_STATUS_WITH_WARN(JniUtil::GetJNIEnv(&env), "Java-Udaf get value function");
+        if (result_type->is_nullable()) {
+            auto& nullable = assert_cast<ColumnNullable&>(to);
+            *output_null_value =
+                    reinterpret_cast<int64_t>(nullable.get_null_map_column().get_raw_data().data);
+            auto& data_col = nullable.get_nested_column();
+
+#ifndef EVALUATE_JAVA_UDAF
+#define EVALUATE_JAVA_UDAF                                                                        \
+    if (data_col.is_column_string()) {                                                            \
+        const ColumnString* str_col = check_and_get_column<ColumnString>(to);                     \
+        ColumnString::Chars& chars = const_cast<ColumnString::Chars&>(str_col->get_chars());      \
+        ColumnString::Offsets& offsets =                                                          \
+                const_cast<ColumnString::Offsets&>(str_col->get_offsets());                       \
+        int increase_buffer_size = 0;                                                             \
+        *output_value_buffer = reinterpret_cast<int64_t>(chars.data());                           \
+        *output_offsets_ptr = reinterpret_cast<int64_t>(offsets.data());                          \
+        *output_intermediate_state_ptr = chars.size();                                            \
+        jboolean res = env->CallNonvirtualBooleanMethod(executor_obj, executor_cl,                \
+                                                        executor_result_id, to.size() - 1);       \
+        while (res != JNI_TRUE) {                                                                 \
+            int32_t buffer_size = IncreaseReservedBufferSize(increase_buffer_size);               \
+            increase_buffer_size++;                                                               \
+            chars.reserve(chars.size() + buffer_size);                                            \
+            chars.resize(chars.size() + buffer_size);                                             \
+            *output_intermediate_state_ptr = chars.size();                                        \
+            res = env->CallNonvirtualBooleanMethod(executor_obj, executor_cl, executor_result_id, \
+                                                   to.size() - 1);                                \
+        }                                                                                         \
+    } else if (data_col.is_numeric() || data_col.is_column_decimal()) {                           \
+        *output_value_buffer = reinterpret_cast<int64_t>(data_col.get_raw_data().data);           \
+        env->CallNonvirtualBooleanMethod(executor_obj, executor_cl, executor_result_id,           \
+                                         to.size() - 1);                                          \
+    } else {                                                                                      \
+        return Status::InvalidArgument(strings::Substitute(                                       \
+                "Java UDAF doesn't support return type is $0 now !", result_type->get_name()));   \
+    }
+#endif
+            EVALUATE_JAVA_UDAF;
+        } else {
+            *output_null_value = -1;
+            *output_value_buffer = reinterpret_cast<int64_t>(to.get_raw_data().data);
+            auto& data_col = to;
+            EVALUATE_JAVA_UDAF;
+            env->CallNonvirtualBooleanMethod(executor_obj, executor_cl, executor_result_id,
+                                             to.size() - 1);
+        }
+        return Status::OK();
+    }
+
+    static const int32_t INITIAL_RESERVED_BUFFER_SIZE = 1024;
+    // TODO: we need a heuristic strategy to increase buffer size for variable-size output.
+    static inline int32_t IncreaseReservedBufferSize(int n) {
+        return INITIAL_RESERVED_BUFFER_SIZE << n;
+    }
+
+    Status register_func_id(JNIEnv* env) {
+        auto register_id = [&](const char* func_name, const char* func_sign, jmethodID& func_id) {
+            func_id = env->GetMethodID(executor_cl, func_name, func_sign);
+            Status s = JniUtil::GetJniExceptionMsg(env);
+            if (!s.ok()) {
+                return Status::InternalError(
+                        strings::Substitute("Java-Udaf register_func_id meet error and error is $0",
+                                            s.get_error_msg()));
+            }
+            return s;
+        };
+
+        RETURN_IF_ERROR(register_id("<init>", UDAF_EXECUTOR_CTOR_SIGNATURE, executor_ctor_id));
+        RETURN_IF_ERROR(register_id("add", UDAF_EXECUTOR_ADD_SIGNATURE, executor_add_id));
+        RETURN_IF_ERROR(register_id("close", UDAF_EXECUTOR_CLOSE_SIGNATURE, executor_close_id));
+        RETURN_IF_ERROR(register_id("merge", UDAF_EXECUTOR_MERGE_SIGNATURE, executor_merge_id));
+        RETURN_IF_ERROR(
+                register_id("serialize", UDAF_EXECUTOR_SERIALIZE_SIGNATURE, executor_serialize_id));
+        RETURN_IF_ERROR(
+                register_id("getValue", UDAF_EXECUTOR_RESULT_SIGNATURE, executor_result_id));
+        serialize_len_id = env->GetFieldID(executor_cl, "serializeLength", "J");
+        RETURN_ERROR_IF_EXC(env);
+        return Status::OK();
+    }
+
+public:
+    jclass executor_cl;
+    jobject executor_obj;
+    jmethodID executor_ctor_id;
+
+    jmethodID executor_add_id;
+    jmethodID executor_merge_id;
+    jmethodID executor_serialize_id;
+    jmethodID executor_result_id;
+    jmethodID executor_close_id;
+    jfieldID serialize_len_id;
+
+    std::unique_ptr<int64_t[]> input_values_buffer_ptr;
+    std::unique_ptr<int64_t[]> input_nulls_buffer_ptr;
+    std::unique_ptr<int64_t[]> input_offsets_ptrs;
+    std::unique_ptr<int64_t> output_value_buffer;
+    std::unique_ptr<int64_t> output_null_value;
+    std::unique_ptr<int64_t> output_offsets_ptr;
+    std::unique_ptr<int64_t> output_intermediate_state_ptr;
+
+    bool first_init;
+    int argument_size = 0;
+    std::string serialize_data;
+};
+
+class AggregateJavaUdaf final
+        : public IAggregateFunctionDataHelper<AggregateJavaUdafData, AggregateJavaUdaf> {
+public:
+    AggregateJavaUdaf(const TFunction& fn, const DataTypes& argument_types, const Array& parameters,
+                      const DataTypePtr& return_type)
+            : IAggregateFunctionDataHelper(argument_types, parameters),
+              fn_(fn),
+              return_type_(return_type) {}
+    ~AggregateJavaUdaf() = default;
+
+    static AggregateFunctionPtr create(const TFunction& fn, const DataTypes& argument_types,
+                                       const Array& parameters, const DataTypePtr& return_type) {
+        return std::make_shared<AggregateJavaUdaf>(fn, argument_types, parameters, return_type);
+    }
+
+    void create(AggregateDataPtr __restrict place) const override {
+        new (place) Data(argument_types.size());
+    }
+
+    String get_name() const override { return fn_.name.function_name; }
+
+    DataTypePtr get_return_type() const override { return return_type_; }
+
+    void add(AggregateDataPtr __restrict place, const IColumn** columns, size_t row_num,
+             Arena*) const override {
+        Status status = Status::OK();
+        RETURN_IF_STATUS_ERROR(status, data(place).init_udaf(fn_));

Review Comment:
   Have test in create function do init operator, but it's unable to get jvm 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org