Auto-generate C API bindings#12
Open
asinghvi17 wants to merge 4 commits into
Open
Conversation
Add cbindgen (0.29) as a build dependency to the zarrs_jl Rust crate so
that `zarrs_jl.h` is auto-generated on every `cargo build`. Opaque handle
types (StorageHandle, ArrayHandle, GroupHandle, IcStorageHandle,
IcRepoHandle, IcSessionHandle) are forward-declared in the header since
their fields contain Rust trait objects that cbindgen cannot translate.
Icechunk functions are guarded behind `#if defined(ZARRS_ICECHUNK)`.
Add a `gen/` directory with a Clang.jl-based generator (modeled after
GDAL.jl) that parses the generated header and produces `src/libzarrs_api.jl`
— a self-contained `module API` with auto-generated ccall wrappers. The
expression rewriter handles four patterns:
- Handle outputs (Ptr{Ptr{X}}) → auto-allocates Ref, returns Ptr{Cvoid}
- String outputs (Ptr{Cstring}) → auto-allocates Ref, frees via zarrsFreeString
- Scalar outputs (Ptr{Int32}/Ptr{Csize_t}) → auto-allocates Ref, returns value
- Buffer pointers (Ptr{UInt64}/Ptr{UInt8}) → left as-is for caller
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update the generator to output `module LibZarrs` directly (replacing the hand-written 779-line module), and update all call sites to match the generated function signatures: - Add explicit `Cint(1)` pretty arg to metadata/attribute string calls - Allocate shape buffers at call sites instead of inside the wrapper - Pass explicit ndim and byte counts to subset/chunk I/O functions - Pass explicit ndim to array_resize and erase_chunk - Wrap Int() around get_dimensionality return (Csize_t → Int) - Wrap Bool() around session_has_changes return (Int32 → Bool) All 190 tests pass with zero regressions. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR addresses the last point from #11. The idea here is that we can automate both the generation of the C header file from Rust (via
cbindgen) and the Julia wrapping of that (via Clang.jl and some expression rewriting to handle the ZarrsResult). I tested this locally and all tests seem to pass.Changelog
This was generated by Claude
Rust crate (deps/zarrs_jl/)
Generator (gen/)
Call-site updates (src/)