-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
bindgen: use bindgen to provide Rust bindings to C - v3 #12062
Draft
jasonish
wants to merge
8
commits into
OISF:master
Choose a base branch
from
jasonish:bindgen/v3
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
dcfaa2c
rust: integrate bindgen to generate rust bindings to C
jasonish 2c0e6a2
github-ci: add clang
jasonish 9a65dbf
app-layer: rename AppLayerEventType to SCAppLayerEventType
jasonish 122d65e
app-layer: remove prototypes from decode.h
jasonish 50993f2
bindgen: export SCAppLayerStateGetEventInfoByIdFn from C to Rust
jasonish 207d7b8
bindgen: export AppProto and AppProtoEnum to Rust
jasonish c3a1bbb
dhcp: use ALPROTO_DHCP from bindgen
jasonish 17b9f5e
bindgen: try passing in CFLAGS to get all include directories
jasonish File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,6 +35,7 @@ jobs: | |
autoconf \ | ||
automake \ | ||
cargo-vendor \ | ||
clang \ | ||
diffutils \ | ||
numactl-devel \ | ||
dpdk-devel \ | ||
|
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
// builds.rs for Suricata | ||
// | ||
// Currently this build.rs only uses bindgen to build some Rust | ||
// bindings to the Suricata C code. | ||
// | ||
// For more info on Rust and the build.rs file, see: | ||
// https://doc.rust-lang.org/cargo/reference/build-scripts.html | ||
fn main() { | ||
let src_dir = std::env::var("TOP_SRCDIR").unwrap_or_else(|_| "..".to_string()); | ||
let build_dir = std::env::var("TOP_BUILDDIR").unwrap_or_else(|_| "..".to_string()); | ||
|
||
// Pull in a simple header that presents no issues with bindgen at | ||
// this time. Multiple headers can be specified. | ||
let mut builder = bindgen::Builder::default() | ||
.parse_callbacks(Box::new(bindgen::CargoCallbacks::new())) | ||
.clang_arg("-DHAVE_CONFIG_H") | ||
.clang_arg("-D__SCFILENAME__=\"\"") | ||
.clang_arg(format!("-I{}/src", &build_dir)); | ||
|
||
let headers = &["app-layer-types.h", "app-layer-protos.h"]; | ||
for header in headers { | ||
builder = builder.header(format!("{}/src/{}", &src_dir, header)); | ||
} | ||
|
||
// Patterns. | ||
builder = builder | ||
.allowlist_item("SCAppLayer.*") | ||
.allowlist_item("AppProto.*"); | ||
|
||
// Rustified enums. | ||
builder = builder | ||
.rustified_enum("SCAppLayerEventType") | ||
.rustified_enum("AppProtoEnum"); | ||
|
||
let bindings = builder.generate().unwrap(); | ||
|
||
// Write out the bindings. *Rules* say we should only write into | ||
// the target directory (idiomatically the OUT_DIR env var), so | ||
// we'll pull them into our namespace using an include!() macro | ||
// (current in sys.rs). | ||
let out_path = std::path::PathBuf::from(std::env::var("OUT_DIR").unwrap()); | ||
bindings | ||
.write_to_file(out_path.join("bindings.rs")) | ||
.unwrap(); | ||
} |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want build-time code execution ? 😢
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already have it for the derive macros. The Lua crate copies in headers at build time as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many crates do that already I know 😢