Kontinuation commented on code in PR #407: URL: https://github.com/apache/sedona-db/pull/407#discussion_r2602581602
########## c/sedona-extension/src/sedona_extension.h: ########## @@ -0,0 +1,208 @@ +// 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. + +#ifndef SEDONA_EXTENSION_H +#define SEDONA_EXTENSION_H + +#include <stdint.h> + +#ifdef __cplusplus +extern "C" { +#endif + +// Extra guard for versions of Arrow without the canonical guard +#ifndef ARROW_FLAG_DICTIONARY_ORDERED + +#ifndef ARROW_C_DATA_INTERFACE +#define ARROW_C_DATA_INTERFACE + +#define ARROW_FLAG_DICTIONARY_ORDERED 1 +#define ARROW_FLAG_NULLABLE 2 +#define ARROW_FLAG_MAP_KEYS_SORTED 4 + +struct ArrowSchema { + // Array type description + const char* format; + const char* name; + const char* metadata; + int64_t flags; + int64_t n_children; + struct ArrowSchema** children; + struct ArrowSchema* dictionary; + + // Release callback + void (*release)(struct ArrowSchema*); + // Opaque producer-specific data + void* private_data; +}; + +struct ArrowArray { + // Array data description + int64_t length; + int64_t null_count; + int64_t offset; + int64_t n_buffers; + int64_t n_children; + const void** buffers; + struct ArrowArray** children; + struct ArrowArray* dictionary; + + // Release callback + void (*release)(struct ArrowArray*); + // Opaque producer-specific data + void* private_data; +}; + +#endif // ARROW_C_DATA_INTERFACE + +#ifndef ARROW_C_STREAM_INTERFACE +#define ARROW_C_STREAM_INTERFACE + +struct ArrowArrayStream { + // Callback to get the stream type + // (will be the same for all arrays in the stream). + // + // Return value: 0 if successful, an `errno`-compatible error code otherwise. + // + // If successful, the ArrowSchema must be released independently from the stream. + int (*get_schema)(struct ArrowArrayStream*, struct ArrowSchema* out); + + // Callback to get the next array + // (if no error and the array is released, the stream has ended) + // + // Return value: 0 if successful, an `errno`-compatible error code otherwise. + // + // If successful, the ArrowArray must be released independently from the stream. + int (*get_next)(struct ArrowArrayStream*, struct ArrowArray* out); + + // Callback to get optional detailed error information. + // This must only be called if the last stream operation failed + // with a non-0 return code. + // + // Return value: pointer to a null-terminated character array describing + // the last error, or NULL if no description is available. + // + // The returned pointer is only valid until the next operation on this stream + // (including release). + const char* (*get_last_error)(struct ArrowArrayStream*); + + // Release callback: release the stream's own resources. + // Note that arrays returned by `get_next` must be individually released. + void (*release)(struct ArrowArrayStream*); + + // Opaque producer-specific data + void* private_data; +}; + +#endif // ARROW_C_STREAM_INTERFACE +#endif // ARROW_FLAG_DICTIONARY_ORDERED + +/// \brief Simple ABI-stable scalar function implementation +/// +/// This object is not thread safe: callers must take care to serialize +/// access to methods if an instance is shared across threads. In general, +/// constructing and initializing this structure should be sufficiently +/// cheap that it shouldn't need to be shared in this way. +/// +/// Briefly, the SedonaCScalarKernelImpl is typically the stack-allocated +/// structure that is not thread safe and the SedonaCScalarKernel is the +/// value that lives in a registry (whose job it is to initialize implementations +/// on each stack that needs one). +struct SedonaCScalarKernelImpl { + /// \brief Initialize the state of this instance and calculate a return type + /// + /// The init callback either computes a return ArrowSchema or initializes the + /// return ArrowSchema to an explicitly released value to indicate that this + /// implementation does not apply to the arguments passed. An implementation + /// that does not apply to the arguments passed is not necessarily an error + /// (there may be another implementation prepared to handle such a case). + /// + /// \param arg_types Argument types + /// \param scalar_args An optional array of scalar arguments. The entire + /// array may be null to indicate that none of the arguments are scalars, or + /// individual items in the array may be NULL to indicate that a particular + /// argument is not a scalar. Any non-NULL arrays must be of length 1. + /// Implementations MAY take ownership over the elements of scalar_args but + /// are not required to do so (i.e., caller must check if these elements were + /// released, and must release them if needed). + /// \param n_args Number of elements in the arg_types and/or scalar_args arrays. + /// \param out Will be populated with the return type on success, or initialized + /// to a released value if this implementation does not apply to the arguments + /// passed. + /// + /// \return An errno-compatible error code, or zero on success. + int (*init)(struct SedonaCScalarKernelImpl* self, const struct ArrowSchema** arg_types, Review Comment: Should the type of `arg_types` be `const struct ArrowSchema* const*`? ########## c/sedona-extension/src/scalar_kernel.rs: ########## @@ -0,0 +1,883 @@ +// 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. + +use arrow_array::{ + ffi::{from_ffi_and_data_type, FFI_ArrowArray, FFI_ArrowSchema}, + make_array, ArrayRef, +}; +use arrow_schema::{ArrowError, Field}; +use datafusion_common::{plan_err, DataFusionError, Result, ScalarValue}; +use datafusion_expr::ColumnarValue; +use sedona_common::sedona_internal_err; +use sedona_expr::scalar_udf::{ScalarKernelRef, SedonaScalarKernel}; +use sedona_schema::datatypes::SedonaType; +use std::{ + ffi::{c_char, c_int, c_void, CStr, CString}, + fmt::Debug, + iter::zip, + ptr::{null, null_mut, swap_nonoverlapping}, + str::FromStr, +}; + +use crate::extension::{ffi_arrow_schema_is_valid, SedonaCScalarKernel, SedonaCScalarKernelImpl}; + +/// Wrapper around a [SedonaCScalarKernel] that implements [SedonaScalarKernel] +/// +/// This is the means by which a kernel implementation may be imported from a +/// C implementation. +pub struct ImportedScalarKernel { + inner: SedonaCScalarKernel, + function_name: Option<String>, +} + +impl Debug for ImportedScalarKernel { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("ImportedScalarKernel") + .field("inner", &"<SedonaCScalarKernel>") + .finish() + } +} + +impl TryFrom<SedonaCScalarKernel> for ImportedScalarKernel { + type Error = DataFusionError; + + fn try_from(value: SedonaCScalarKernel) -> Result<Self> { + match ( + &value.function_name, + &value.new_impl, + &value.release, + value.private_data.is_null(), Review Comment: Is it possible that an implementation of `SedonaCScalarKernel` does not need private data at all? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
