You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "tustvold (via GitHub)" <gi...@apache.org> on 2023/11/16 11:54:43 UTC
[PR] Add FFI from_raw [arrow-rs]
tustvold opened a new pull request, #5082:
URL: https://github.com/apache/arrow-rs/pull/5082
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
Closes #.
# Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
This makes it easier to correctly move data across FFI boundaries
# What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
# Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!---
If there are any breaking changes to public APIs, please add the `breaking change` label.
-->
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add FFI from_raw [arrow-rs]
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #5082:
URL: https://github.com/apache/arrow-rs/pull/5082#discussion_r1395652593
##########
arrow-data/src/ffi.rs:
##########
@@ -191,6 +191,22 @@ impl FFI_ArrowArray {
}
}
+ /// Takes ownership of the pointed to [`FFI_ArrowArray`]
+ ///
+ /// This acts to [move] the data out of `array`, setting the release callback to NULL
+ ///
+ /// # Safety
+ ///
+ /// * `array` must be [valid] for reads and writes
+ /// * `array` must be properly aligned
+ /// * `array` must point to a properly initialized value of [`FFI_ArrowArray`]
+ ///
+ /// [move]: https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array
+ /// [valid]: https://doc.rust-lang.org/std/ptr/index.html#safety
+ pub unsafe fn from_raw(array: *mut FFI_ArrowArray) -> Self {
+ std::ptr::replace(array, Self::empty())
Review Comment:
The problem is I don't think we can, as things like FFI streams rely on the release pointer for things like detecting the end of stream
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add FFI from_raw [arrow-rs]
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold merged PR #5082:
URL: https://github.com/apache/arrow-rs/pull/5082
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add FFI from_raw [arrow-rs]
Posted by "pitrou (via GitHub)" <gi...@apache.org>.
pitrou commented on code in PR #5082:
URL: https://github.com/apache/arrow-rs/pull/5082#discussion_r1395620068
##########
arrow-data/src/ffi.rs:
##########
@@ -191,6 +191,22 @@ impl FFI_ArrowArray {
}
}
+ /// Takes ownership of the pointed to [`FFI_ArrowArray`]
+ ///
+ /// This acts to [move] the data out of `array`, setting the release callback to NULL
+ ///
+ /// # Safety
+ ///
+ /// * `array` must be [valid] for reads and writes
+ /// * `array` must be properly aligned
+ /// * `array` must point to a properly initialized value of [`FFI_ArrowArray`]
+ ///
+ /// [move]: https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array
+ /// [valid]: https://doc.rust-lang.org/std/ptr/index.html#safety
+ pub unsafe fn from_raw(array: *mut FFI_ArrowArray) -> Self {
+ std::ptr::replace(array, Self::empty())
Review Comment:
Asserting that the release pointer isn't NULL sounds good to me.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add FFI from_raw [arrow-rs]
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #5082:
URL: https://github.com/apache/arrow-rs/pull/5082#discussion_r1395652593
##########
arrow-data/src/ffi.rs:
##########
@@ -191,6 +191,22 @@ impl FFI_ArrowArray {
}
}
+ /// Takes ownership of the pointed to [`FFI_ArrowArray`]
+ ///
+ /// This acts to [move] the data out of `array`, setting the release callback to NULL
+ ///
+ /// # Safety
+ ///
+ /// * `array` must be [valid] for reads and writes
+ /// * `array` must be properly aligned
+ /// * `array` must point to a properly initialized value of [`FFI_ArrowArray`]
+ ///
+ /// [move]: https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array
+ /// [valid]: https://doc.rust-lang.org/std/ptr/index.html#safety
+ pub unsafe fn from_raw(array: *mut FFI_ArrowArray) -> Self {
+ std::ptr::replace(array, Self::empty())
Review Comment:
The problem is I don't think we can, as things like FFI streams rely on the release pointer for things like detecting the end of stream
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add FFI from_raw [arrow-rs]
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #5082:
URL: https://github.com/apache/arrow-rs/pull/5082#discussion_r1395589789
##########
arrow-data/src/ffi.rs:
##########
@@ -191,6 +191,22 @@ impl FFI_ArrowArray {
}
}
+ /// Takes ownership of the pointed to [`FFI_ArrowArray`]
+ ///
+ /// This acts to [move] the data out of `array`, setting the release callback to NULL
+ ///
+ /// # Safety
+ ///
+ /// * `array` must be [valid] for reads and writes
+ /// * `array` must be properly aligned
+ /// * `array` must point to a properly initialized value of [`FFI_ArrowArray`]
+ ///
+ /// [move]: https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array
+ /// [valid]: https://doc.rust-lang.org/std/ptr/index.html#safety
+ pub unsafe fn from_raw(array: *mut FFI_ArrowArray) -> Self {
+ std::ptr::replace(array, Self::empty())
Review Comment:
Something that occurs to me is we don't verify that release isn't NULL, as it can't be an invariant that `FFI_ArrowArray` doesn't have a null release callback for obvious reasons, but then the accessors assume the data is valid. Perhaps we should probably be also asserting that `FFI_ArrowArray` hasn't been released in the accessors?
The good news is I don't think you can hit this with safe code, but it is potentially interesting
##########
arrow-data/src/ffi.rs:
##########
@@ -191,6 +191,22 @@ impl FFI_ArrowArray {
}
}
+ /// Takes ownership of the pointed to [`FFI_ArrowArray`]
+ ///
+ /// This acts to [move] the data out of `array`, setting the release callback to NULL
+ ///
+ /// # Safety
+ ///
+ /// * `array` must be [valid] for reads and writes
+ /// * `array` must be properly aligned
+ /// * `array` must point to a properly initialized value of [`FFI_ArrowArray`]
+ ///
+ /// [move]: https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array
+ /// [valid]: https://doc.rust-lang.org/std/ptr/index.html#safety
+ pub unsafe fn from_raw(array: *mut FFI_ArrowArray) -> Self {
+ std::ptr::replace(array, Self::empty())
Review Comment:
Something that occurs to me is we don't verify that release isn't NULL, as it can't be an invariant that `FFI_ArrowArray` doesn't have a null release callback for obvious reasons, but then the accessors assume the data is valid. Perhaps we should be asserting that `FFI_ArrowArray` hasn't been released in the accessors?
The good news is I don't think you can hit this with safe code, but it is potentially interesting
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add FFI from_raw [arrow-rs]
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #5082:
URL: https://github.com/apache/arrow-rs/pull/5082#discussion_r1395589789
##########
arrow-data/src/ffi.rs:
##########
@@ -191,6 +191,22 @@ impl FFI_ArrowArray {
}
}
+ /// Takes ownership of the pointed to [`FFI_ArrowArray`]
+ ///
+ /// This acts to [move] the data out of `array`, setting the release callback to NULL
+ ///
+ /// # Safety
+ ///
+ /// * `array` must be [valid] for reads and writes
+ /// * `array` must be properly aligned
+ /// * `array` must point to a properly initialized value of [`FFI_ArrowArray`]
+ ///
+ /// [move]: https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array
+ /// [valid]: https://doc.rust-lang.org/std/ptr/index.html#safety
+ pub unsafe fn from_raw(array: *mut FFI_ArrowArray) -> Self {
+ std::ptr::replace(array, Self::empty())
Review Comment:
Something that occurs to me is we don't verify that release isn't NULL, as it can't be an invariant that `FFI_ArrowArray` doesn't have a null release callback for obvious reasons, but then the accessors assume the data is valid. I think we should probably be also asserting that `FFI_ArrowArray` hasn't been released?
The good news is I don't think you can hit this with safe code, but it is potentially interesting
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org