bindgen: use bindgen to provide Rust bindings to C - v9 #12578
Closed
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
Require a minimum version of 0.66.0.
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.
Regenerates the `sys.rs` and looks for any difference. Check will fail if there is a difference.
We don't keep bindgen's autogenerated do not edit line as it contains the bindgen version which could break the CI check for out of date bindings. So add our own do not edit line.
jasonish
requested review from
jufajardini,
victorjulien,
catenacyber and
a team
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #12578 +/- ##
==========================================
- Coverage 80.72% 80.71% -0.01%
==========================================
Files 929 929
Lines 259062 259062
==========================================
- Hits 209119 209100 -19
- Misses 49943 49962 +19
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Information: QA ran without warnings. Pipeline 24720 |
|
See this fail on one of my arm 32bit runners, but not on all of them |
|
The job is using alpine:latest, which uses musl. Perhaps that is related. |
|
Also fails my freebsd builder |
Interesting. I wonder if the size of a Rust Appears there are some known cases where the generated tests don't work on a different size arch, but the bindings themselves are fine. |
Appears the generated tests check for the pointer width on the machine type generating the bindings. So its a good sanity check, but only on the same architecture. Worst case we disable automake test generation (cbindgen doesn't have them either), or see if we can easily gate them to the arch generating the bindings. |
|
Appears to only be the tests that differ when the bindings are generated on arm32. diff --git a/rust/sys/src/sys.rs b/rust/sys/src/sys.rs
index 91dae8dc0..7717f89e1 100644
--- a/rust/sys/src/sys.rs
+++ b/rust/sys/src/sys.rs
@@ -69,53 +69,33 @@ fn bindgen_test_layout_SCPlugin_() {
let ptr = UNINIT.as_ptr();
assert_eq!(
::std::mem::size_of::<SCPlugin_>(),
- 32usize,
- concat!("Size of: ", stringify!(SCPlugin_))
+ 16usize,
+ "Size of SCPlugin_"
);
assert_eq!(
::std::mem::align_of::<SCPlugin_>(),
- 8usize,
- concat!("Alignment of ", stringify!(SCPlugin_))
+ 4usize,
+ "Alignment of SCPlugin_"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).name) as usize - ptr as usize },
0usize,
- concat!(
- "Offset of field: ",
- stringify!(SCPlugin_),
- "::",
- stringify!(name)
- )
+ "Offset of field: SCPlugin_::name"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).license) as usize - ptr as usize },
- 8usize,
- concat!(
- "Offset of field: ",
- stringify!(SCPlugin_),
- "::",
- stringify!(license)
- )
+ 4usize,
+ "Offset of field: SCPlugin_::license"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).author) as usize - ptr as usize },
- 16usize,
- concat!(
- "Offset of field: ",
- stringify!(SCPlugin_),
- "::",
- stringify!(author)
- )
+ 8usize,
+ "Offset of field: SCPlugin_::author"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).Init) as usize - ptr as usize },
- 24usize,
- concat!(
- "Offset of field: ",
- stringify!(SCPlugin_),
- "::",
- stringify!(Init)
- )
+ 12usize,
+ "Offset of field: SCPlugin_::Init"
);
}
#[doc = " Structure to define a Suricata plugin."]
@@ -163,33 +143,23 @@ fn bindgen_test_layout_SCCapturePlugin___bindgen_ty_1() {
let ptr = UNINIT.as_ptr();
assert_eq!(
::std::mem::size_of::<SCCapturePlugin___bindgen_ty_1>(),
- 16usize,
- concat!("Size of: ", stringify!(SCCapturePlugin___bindgen_ty_1))
+ 8usize,
+ "Size of SCCapturePlugin___bindgen_ty_1"
);
assert_eq!(
::std::mem::align_of::<SCCapturePlugin___bindgen_ty_1>(),
- 8usize,
- concat!("Alignment of ", stringify!(SCCapturePlugin___bindgen_ty_1))
+ 4usize,
+ "Alignment of SCCapturePlugin___bindgen_ty_1"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).tqe_next) as usize - ptr as usize },
0usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin___bindgen_ty_1),
- "::",
- stringify!(tqe_next)
- )
+ "Offset of field: SCCapturePlugin___bindgen_ty_1::tqe_next"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).tqe_prev) as usize - ptr as usize },
- 8usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin___bindgen_ty_1),
- "::",
- stringify!(tqe_prev)
- )
+ 4usize,
+ "Offset of field: SCCapturePlugin___bindgen_ty_1::tqe_prev"
);
}
#[test]
@@ -198,73 +168,43 @@ fn bindgen_test_layout_SCCapturePlugin_() {
let ptr = UNINIT.as_ptr();
assert_eq!(
::std::mem::size_of::<SCCapturePlugin_>(),
- 56usize,
- concat!("Size of: ", stringify!(SCCapturePlugin_))
+ 28usize,
+ "Size of SCCapturePlugin_"
);
assert_eq!(
::std::mem::align_of::<SCCapturePlugin_>(),
- 8usize,
- concat!("Alignment of ", stringify!(SCCapturePlugin_))
+ 4usize,
+ "Alignment of SCCapturePlugin_"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).name) as usize - ptr as usize },
0usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin_),
- "::",
- stringify!(name)
- )
+ "Offset of field: SCCapturePlugin_::name"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).Init) as usize - ptr as usize },
- 8usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin_),
- "::",
- stringify!(Init)
- )
+ 4usize,
+ "Offset of field: SCCapturePlugin_::Init"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).ThreadInit) as usize - ptr as usize },
- 16usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin_),
- "::",
- stringify!(ThreadInit)
- )
+ 8usize,
+ "Offset of field: SCCapturePlugin_::ThreadInit"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).ThreadDeinit) as usize - ptr as usize },
- 24usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin_),
- "::",
- stringify!(ThreadDeinit)
- )
+ 12usize,
+ "Offset of field: SCCapturePlugin_::ThreadDeinit"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).GetDefaultMode) as usize - ptr as usize },
- 32usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin_),
- "::",
- stringify!(GetDefaultMode)
- )
+ 16usize,
+ "Offset of field: SCCapturePlugin_::GetDefaultMode"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).entries) as usize - ptr as usize },
- 40usize,
- concat!(
- "Offset of field: ",
- stringify!(SCCapturePlugin_),
- "::",
- stringify!(entries)
- )
+ 20usize,
+ "Offset of field: SCCapturePlugin_::entries"
);
}
pub type SCCapturePlugin = SCCapturePlugin_;
@@ -293,83 +233,48 @@ fn bindgen_test_layout_SCAppLayerPlugin_() {
let ptr = UNINIT.as_ptr();
assert_eq!(
::std::mem::size_of::<SCAppLayerPlugin_>(),
- 56usize,
- concat!("Size of: ", stringify!(SCAppLayerPlugin_))
+ 32usize,
+ "Size of SCAppLayerPlugin_"
);
assert_eq!(
::std::mem::align_of::<SCAppLayerPlugin_>(),
8usize,
- concat!("Alignment of ", stringify!(SCAppLayerPlugin_))
+ "Alignment of SCAppLayerPlugin_"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).version) as usize - ptr as usize },
0usize,
- concat!(
- "Offset of field: ",
- stringify!(SCAppLayerPlugin_),
- "::",
- stringify!(version)
- )
+ "Offset of field: SCAppLayerPlugin_::version"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).name) as usize - ptr as usize },
8usize,
- concat!(
- "Offset of field: ",
- stringify!(SCAppLayerPlugin_),
- "::",
- stringify!(name)
- )
+ "Offset of field: SCAppLayerPlugin_::name"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).Register) as usize - ptr as usize },
- 16usize,
- concat!(
- "Offset of field: ",
- stringify!(SCAppLayerPlugin_),
- "::",
- stringify!(Register)
- )
+ 12usize,
+ "Offset of field: SCAppLayerPlugin_::Register"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).KeywordsRegister) as usize - ptr as usize },
- 24usize,
- concat!(
- "Offset of field: ",
- stringify!(SCAppLayerPlugin_),
- "::",
- stringify!(KeywordsRegister)
- )
+ 16usize,
+ "Offset of field: SCAppLayerPlugin_::KeywordsRegister"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).logname) as usize - ptr as usize },
- 32usize,
- concat!(
- "Offset of field: ",
- stringify!(SCAppLayerPlugin_),
- "::",
- stringify!(logname)
- )
+ 20usize,
+ "Offset of field: SCAppLayerPlugin_::logname"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).confname) as usize - ptr as usize },
- 40usize,
- concat!(
- "Offset of field: ",
- stringify!(SCAppLayerPlugin_),
- "::",
- stringify!(confname)
- )
+ 24usize,
+ "Offset of field: SCAppLayerPlugin_::confname"
);
assert_eq!(
unsafe { ::std::ptr::addr_of!((*ptr).Logger) as usize - ptr as usize },
- 48usize,
- concat!(
- "Offset of field: ",
- stringify!(SCAppLayerPlugin_),
- "::",
- stringify!(Logger)
- )
+ 28usize,
+ "Offset of field: SCAppLayerPlugin_::Logger"
);
}
pub type SCAppLayerPlugin = SCAppLayerPlugin_; |
|
Replaced by #12589 |
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.
Previous PR: #12466