aya-obj: move code for object file loading and relocation into a separate crate #475
Conversation
✅ Deploy Preview for aya-rs-docs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Thanks for doing this! Just some high level comments, I'll do a proper review soon
The files are identical today yes, given the bindings we generate. The input headers aren't arch independent tho, we don't control them, and we might add arch dependent bindings at some point in the future, so the best thing to do is to generate them separately.
Haha thanks for this! I'll keep it in mind while reviewing.
Amazing!
Skimming through the diff I couldn't immediately understand why this was needed? I'm assuming it has to do with dependencies on some generated stuff?
Cool
Awesome! |
|
I see, makes sense. Just as a note (mostly to self), it looks like those types are accidentally public but only used internally, we should remove the re-export but safer to do so in a separate PR.
Yeah these are fine. Well, this looks great! Thanks again for doing it, it's late here now but I'll do a proper review tomorrow. |
|
@dave-tucker tagging you in case you want to take a look too as iirc you mentioned doing something like this a while back. This looks good to me so I'm going to review and aim to merge ~soon unless you have any comments. |
Aya::obj depends on bindgen generated files, and we start by migrating bindgen generated files. This commit adds the new aya-obj crate to the workplace and migrates generated files into the crate. We use core instead of std in an effort to make the final crate no_std. Bindgen was run against libbpf v1.0.1. Refs: aya-rs#473
To split the crate into two, several changes were made:
1. Most `pub(crate)` are now `pub` to allow access from Aya;
2. Parts of BpfError are merged into, for example, RelocationError;
3. BTF part of Features is moved into the new crate;
4. `#![deny(missing_docs)]` is removed temporarily;
5. Some other code gets moved into the new crate, mainly:
- aya::{bpf_map_def, BtfMapDef, PinningType},
- aya::programs::{CgroupSock*AttachType},
The new crate is currenly allowing missing_docs. Member visibility
will be adjusted later to minimize exposure of implementation details.
Refs: aya-rs#473
Types relevant to maps are moved into aya_obj::maps. Some members are marked `pub(crate)` again. Refs: aya-rs#473
The crate has few libstd dependencies. Since it should be platform- independent in principle, making it no_std like the object crate would seem reasonable. However, the feature `error_in_core` is not yet stabilized, and the thiserror crate currently offers no no_std support. When the feature no_std is selected, we enable the `error_in_core` feature, switch to thiserror-core and replace the HashMap with the one in hashbrown.
This commit adds documentation on how program names are parsed from section names, as is used by `aya_obj::Object.programs` as HashMap keys, and updates the examples into using program names.
- Set the version number of `aya-obj` to `0.1.0`. - Update the description of the `aya-obj` crate. - Add a section in README and rustdoc warning about the unstable API.
dave-tucker
added
aya-obj
|
Hey, I found this PR while looking at who's been using rbpf -- I just wanted to say that I'm super happy that you have some tests with rbpf in Aya! Thanks for this work! ❤️ |
This PR moves some platform-independent code into a separate
aya-objcrate. Changes include:aya::generated- Depended upon byaya::objand moved intoaya-objas well.Actually, contents in
aya/src/generated/linux_bindings_*.rsseem to be identical andplatform-independent. Theses files were re-generated with rust-bindgen v0.63 with
use_core.aya::obj- The main part.mapmodule.ayahave their visibility changed topub.no_stdfeature was added.aya::programs::CgroupSock*AttachTypeand some map definition types were moved.aya::bpf::Featureswas split intoFeaturesandBtfFeatureswith the latter moved.Closes #473