martin-g commented on code in PR #18657: URL: https://github.com/apache/datafusion/pull/18657#discussion_r2519834426
########## datafusion/ffi/src/catalog_provider_list.rs: ########## @@ -0,0 +1,283 @@ +// 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 std::{any::Any, ffi::c_void, sync::Arc}; + +use abi_stable::{ + std_types::{ROption, RString, RVec}, + StableAbi, +}; +use datafusion::catalog::{CatalogProvider, CatalogProviderList}; +use tokio::runtime::Handle; + +use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider}; + +/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries. +#[repr(C)] +#[derive(Debug, StableAbi)] +#[allow(non_camel_case_types)] +pub struct FFI_CatalogProviderList { + /// Register a catalog + pub register_catalog: unsafe extern "C" fn( + &Self, + name: RString, + catalog: &FFI_CatalogProvider, Review Comment: ```suggestion catalog_provider: &FFI_CatalogProvider, ``` ########## datafusion/ffi/src/catalog_provider_list.rs: ########## @@ -0,0 +1,283 @@ +// 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 std::{any::Any, ffi::c_void, sync::Arc}; + +use abi_stable::{ + std_types::{ROption, RString, RVec}, + StableAbi, +}; +use datafusion::catalog::{CatalogProvider, CatalogProviderList}; +use tokio::runtime::Handle; + +use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider}; + +/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries. +#[repr(C)] +#[derive(Debug, StableAbi)] +#[allow(non_camel_case_types)] +pub struct FFI_CatalogProviderList { + /// Register a catalog + pub register_catalog: unsafe extern "C" fn( Review Comment: ```suggestion pub register_catalog_provider: unsafe extern "C" fn( ``` ########## datafusion/ffi/src/catalog_provider_list.rs: ########## @@ -0,0 +1,283 @@ +// 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 std::{any::Any, ffi::c_void, sync::Arc}; + +use abi_stable::{ + std_types::{ROption, RString, RVec}, + StableAbi, +}; +use datafusion::catalog::{CatalogProvider, CatalogProviderList}; +use tokio::runtime::Handle; + +use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider}; + +/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries. +#[repr(C)] +#[derive(Debug, StableAbi)] +#[allow(non_camel_case_types)] +pub struct FFI_CatalogProviderList { + /// Register a catalog + pub register_catalog: unsafe extern "C" fn( + &Self, + name: RString, + catalog: &FFI_CatalogProvider, + ) -> ROption<FFI_CatalogProvider>, + + /// List of existing catalogs + pub catalog_names: unsafe extern "C" fn(&Self) -> RVec<RString>, + + /// Access a catalog + pub catalog: Review Comment: ```suggestion pub catalog_provider: ``` ########## datafusion/ffi/src/catalog_provider_list.rs: ########## @@ -0,0 +1,283 @@ +// 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 std::{any::Any, ffi::c_void, sync::Arc}; + +use abi_stable::{ + std_types::{ROption, RString, RVec}, + StableAbi, +}; +use datafusion::catalog::{CatalogProvider, CatalogProviderList}; +use tokio::runtime::Handle; + +use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider}; + +/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries. +#[repr(C)] +#[derive(Debug, StableAbi)] +#[allow(non_camel_case_types)] +pub struct FFI_CatalogProviderList { + /// Register a catalog + pub register_catalog: unsafe extern "C" fn( + &Self, + name: RString, + catalog: &FFI_CatalogProvider, + ) -> ROption<FFI_CatalogProvider>, + + /// List of existing catalogs + pub catalog_names: unsafe extern "C" fn(&Self) -> RVec<RString>, + + /// Access a catalog + pub catalog: + unsafe extern "C" fn(&Self, name: RString) -> ROption<FFI_CatalogProvider>, + + /// Used to create a clone on the provider of the execution plan. This should + /// only need to be called by the receiver of the plan. + pub clone: unsafe extern "C" fn(plan: &Self) -> Self, + + /// Release the memory of the private data when it is no longer being used. + pub release: unsafe extern "C" fn(arg: &mut Self), + + /// Return the major DataFusion version number of this provider. + pub version: unsafe extern "C" fn() -> u64, + + /// Internal data. This is only to be accessed by the provider of the plan. + /// A [`ForeignCatalogProviderList`] should never attempt to access this data. + pub private_data: *mut c_void, +} + +unsafe impl Send for FFI_CatalogProviderList {} +unsafe impl Sync for FFI_CatalogProviderList {} + +struct ProviderPrivateData { + provider: Arc<dyn CatalogProviderList + Send>, + runtime: Option<Handle>, +} + +impl FFI_CatalogProviderList { + unsafe fn inner(&self) -> &Arc<dyn CatalogProviderList + Send> { + let private_data = self.private_data as *const ProviderPrivateData; + &(*private_data).provider + } + + unsafe fn runtime(&self) -> Option<Handle> { + let private_data = self.private_data as *const ProviderPrivateData; + (*private_data).runtime.clone() + } +} + +unsafe extern "C" fn catalog_names_fn_wrapper( + provider: &FFI_CatalogProviderList, +) -> RVec<RString> { + let names = provider.inner().catalog_names(); + names.into_iter().map(|s| s.into()).collect() +} + +unsafe extern "C" fn register_catalog_fn_wrapper( Review Comment: ```suggestion unsafe extern "C" fn register_catalog_provider_fn_wrapper( ``` ########## datafusion/ffi/src/catalog_provider_list.rs: ########## @@ -0,0 +1,283 @@ +// 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 std::{any::Any, ffi::c_void, sync::Arc}; + +use abi_stable::{ + std_types::{ROption, RString, RVec}, + StableAbi, +}; +use datafusion::catalog::{CatalogProvider, CatalogProviderList}; +use tokio::runtime::Handle; + +use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider}; + +/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries. +#[repr(C)] +#[derive(Debug, StableAbi)] +#[allow(non_camel_case_types)] +pub struct FFI_CatalogProviderList { + /// Register a catalog + pub register_catalog: unsafe extern "C" fn( + &Self, + name: RString, + catalog: &FFI_CatalogProvider, + ) -> ROption<FFI_CatalogProvider>, + + /// List of existing catalogs + pub catalog_names: unsafe extern "C" fn(&Self) -> RVec<RString>, Review Comment: ```suggestion pub catalog_provider_names: unsafe extern "C" fn(&Self) -> RVec<RString>, ``` ########## datafusion/ffi/src/catalog_provider_list.rs: ########## @@ -0,0 +1,283 @@ +// 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 std::{any::Any, ffi::c_void, sync::Arc}; + +use abi_stable::{ + std_types::{ROption, RString, RVec}, + StableAbi, +}; +use datafusion::catalog::{CatalogProvider, CatalogProviderList}; +use tokio::runtime::Handle; + +use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider}; + +/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries. +#[repr(C)] +#[derive(Debug, StableAbi)] +#[allow(non_camel_case_types)] +pub struct FFI_CatalogProviderList { + /// Register a catalog + pub register_catalog: unsafe extern "C" fn( + &Self, + name: RString, + catalog: &FFI_CatalogProvider, + ) -> ROption<FFI_CatalogProvider>, + + /// List of existing catalogs + pub catalog_names: unsafe extern "C" fn(&Self) -> RVec<RString>, + + /// Access a catalog + pub catalog: + unsafe extern "C" fn(&Self, name: RString) -> ROption<FFI_CatalogProvider>, + + /// Used to create a clone on the provider of the execution plan. This should Review Comment: execution plan ? Is this correct or copy/paste error ? ########## datafusion/ffi/src/catalog_provider_list.rs: ########## @@ -0,0 +1,283 @@ +// 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 std::{any::Any, ffi::c_void, sync::Arc}; + +use abi_stable::{ + std_types::{ROption, RString, RVec}, + StableAbi, +}; +use datafusion::catalog::{CatalogProvider, CatalogProviderList}; +use tokio::runtime::Handle; + +use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider}; + +/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries. +#[repr(C)] +#[derive(Debug, StableAbi)] +#[allow(non_camel_case_types)] +pub struct FFI_CatalogProviderList { + /// Register a catalog + pub register_catalog: unsafe extern "C" fn( + &Self, + name: RString, + catalog: &FFI_CatalogProvider, + ) -> ROption<FFI_CatalogProvider>, + + /// List of existing catalogs + pub catalog_names: unsafe extern "C" fn(&Self) -> RVec<RString>, + + /// Access a catalog + pub catalog: + unsafe extern "C" fn(&Self, name: RString) -> ROption<FFI_CatalogProvider>, + + /// Used to create a clone on the provider of the execution plan. This should + /// only need to be called by the receiver of the plan. + pub clone: unsafe extern "C" fn(plan: &Self) -> Self, + + /// Release the memory of the private data when it is no longer being used. + pub release: unsafe extern "C" fn(arg: &mut Self), + + /// Return the major DataFusion version number of this provider. + pub version: unsafe extern "C" fn() -> u64, + + /// Internal data. This is only to be accessed by the provider of the plan. + /// A [`ForeignCatalogProviderList`] should never attempt to access this data. + pub private_data: *mut c_void, +} + +unsafe impl Send for FFI_CatalogProviderList {} +unsafe impl Sync for FFI_CatalogProviderList {} + +struct ProviderPrivateData { + provider: Arc<dyn CatalogProviderList + Send>, + runtime: Option<Handle>, +} + +impl FFI_CatalogProviderList { + unsafe fn inner(&self) -> &Arc<dyn CatalogProviderList + Send> { + let private_data = self.private_data as *const ProviderPrivateData; + &(*private_data).provider + } + + unsafe fn runtime(&self) -> Option<Handle> { + let private_data = self.private_data as *const ProviderPrivateData; + (*private_data).runtime.clone() + } +} + +unsafe extern "C" fn catalog_names_fn_wrapper( + provider: &FFI_CatalogProviderList, +) -> RVec<RString> { + let names = provider.inner().catalog_names(); + names.into_iter().map(|s| s.into()).collect() +} + +unsafe extern "C" fn register_catalog_fn_wrapper( Review Comment: Or: ```suggestion unsafe extern "C" fn register_provider_fn_wrapper( ``` -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
