bindgen: use bindgen to provide Rust bindings to C - v8 #12466
+218
−26
Conversation
This file contains 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
Follow Rust convention of using a "sys" crate for bindings to C functions. The bindings don't exist yet, but will be generated by bindgen and put into this crate.
Bindgen works by processing a header file which includes all other header files it should generate bindings for. For this I've created bindgen.h which just includes app-layer-protos.h for now as an example. These bindings are then generated and saved in the "suricata-sys" crate and become availale as "suricata_sys::sys".
Have bindgen generate bindings for app-layer-protos.h, then use the generated definitions of AppProto/AppProtoEnum instead if defining them ourselves. This header was chosen as its used by Rust, and its a simple header with no circular dependencies.
jasonish
requested review from
jufajardini,
victorjulien,
catenacyber and
a team
as code owners
jasonish
commented
Jan 23, 2025
Comment on lines
+1
to
+7
| #[repr(u32)] | ||
| #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)] | ||
| pub enum AppProtoEnum { | ||
| ALPROTO_UNKNOWN = 0, | ||
| ALPROTO_FAILED = 1, | ||
| ALPROTO_HTTP1 = 2, | ||
| ALPROTO_FTP = 3, |
There was a problem hiding this comment.
Could also do:
pub const AppProtoEnum_ALPROTO_UNKNOWN: AppProtoEnum = 0;
pub const AppProtoEnum_ALPROTO_FAILED: AppProtoEnum = 1;
pub const AppProtoEnum_ALPROTO_HTTP1: AppProtoEnum = 2;
pub const AppProtoEnum_ALPROTO_FTP: AppProtoEnum = 3;
There was a problem hiding this comment.
Is it right to have a rust AppProtoEnum ? when we want dynamic AppProto cf #12420 and rejected https://redmine.openinfosecfoundation.org/issues/3524 ?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #12466 +/- ##
=======================================
Coverage 80.63% 80.64%
=======================================
Files 920 920
Lines 258739 258739
=======================================
+ Hits 208643 208648 +5
+ Misses 50096 50091 -5
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Information: QA ran without warnings. Pipeline 24340 |
catenacyber
reviewed
Jan 24, 2025
| } | ||
| pub type AppProto = u16; | ||
| extern "C" { | ||
| #[doc = " \\brief Maps the ALPROTO_*, to its string equivalent.\n\n \\param alproto App layer protocol id.\n\n \\retval String equivalent for the alproto."] |
There was a problem hiding this comment.
nit: We do not need to export the comment I guess
catenacyber
reviewed
Jan 24, 2025
| @@ -79,14 +79,49 @@ clean-local: | |||
| distclean-local: | |||
| rm -rf vendor dist | |||
|
|
|||
| check-bindgen-bindings: | |||
There was a problem hiding this comment.
There should be a CI test with bindgen
catenacyber
reviewed
Jan 24, 2025
| pub const ALPROTO_UNKNOWN : AppProto = 0; | ||
| pub const ALPROTO_FAILED : AppProto = 1; | ||
| pub const ALPROTO_UNKNOWN : AppProto = AppProtoEnum::ALPROTO_UNKNOWN as AppProto; | ||
| pub const ALPROTO_FAILED : AppProto = AppProtoEnum::ALPROTO_FAILED as AppProto; |
There was a problem hiding this comment.
Oh AppProtoEnum. as AppProto...
|
This looks nice overall. What is the remaining work to do ?
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A simpler, more focused version of #12461.
app-layer-protos.hand update Rust code to use the generated bindings.AppProtocould have been more more minimal by re-exporting fromcore, but I don't like the idea of add re-exports.