Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of unsafe in compute kernels #142

Closed
alamb opened this issue Apr 26, 2021 · 2 comments
Closed

Document use of unsafe in compute kernels #142

alamb opened this issue Apr 26, 2021 · 2 comments
Labels
arrow Changes to the arrow crate security

Comments

@alamb
Copy link
Contributor

alamb commented Apr 26, 2021

Note: migrated from original JIRA: https://issues.apache.org/jira/browse/ARROW-10973

There are ~7 uses of unsafe in the compute kernels and we should document them according to the guidelines in the Arrow crate README

 
{code:java}
// JUSTIFICATION
// Benefit
// Describe the benefit of using unsafe. E.g.
// "30% performance degradation if the safe counterpart is used, see bench X."
// Soundness
// Describe why the code remains sound (according to the definition of rust's unsafe code guidelines). E.g.
// "We bounded check these values at initialization and the array is immutable."
let ... = unsafe { ... }; {code}

@alamb alamb added the arrow Changes to the arrow crate label Apr 26, 2021
@ByteBaker
Copy link
Contributor

There are no more unsafe blocks in the file. We can close this. @alamb

@alamb
Copy link
Contributor Author

alamb commented Oct 4, 2024

Thanks @ByteBaker

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate security
Projects
None yet
Development

No branches or pull requests

3 participants