rust/ffi: use Flow wrapper in eve callback signature

Author: jasonish

doc/userguide/devguide/extending/output/eve-hooks.rst

@@ -56,7 +56,7 @@ The closure receives:
 
 - ``tv``: the ``ThreadVars`` for the thread performing the logging
 - ``p``: the ``Packet``, or ``None`` if not available
-- ``f``: the ``Flow``, if available
+- ``f``: the ``Flow``, or ``None`` if not available
 - ``jb``: a Rust ``JsonBuilder`` wrapper for the current EVE record
 
 Unlike the C API, the Rust callback returns ``Result<(), Error>``. If it

examples/plugins/rust/src/mod.rs

@@ -1,12 +1,12 @@
 use std::ptr::null_mut;
 
 use suricata_ffi::eve::{self, SCJsonBuilder};
-use suricata_ffi::flow;
+use suricata_ffi::flow::{self, Flow};
 use suricata_ffi::jsonbuilder::JsonBuilder;
 use suricata_ffi::packet::Packet;
 use suricata_ffi::{SCLogError, SCLogNotice};
 use suricata_sys::sys::{
-    Flow, Packet as RawPacket, SCEveRegisterCallback, SCPlugin, ThreadVars,
+    Flow as RawFlow, Packet as RawPacket, SCEveRegisterCallback, SCPlugin, ThreadVars,
 };
 
 unsafe extern "C" fn init() {
@@ -44,7 +44,7 @@ pub fn register_flow_callbacks() -> Result<(), &'static str> {
 unsafe extern "C" fn log_eve_raw(
     _tv: *mut ThreadVars,
     _p: *const RawPacket,
-    _f: *mut Flow,
+    _f: *mut RawFlow,
     jb: *mut SCJsonBuilder,
     _user: *mut std::os::raw::c_void,
 ) {
@@ -57,34 +57,34 @@ unsafe extern "C" fn log_eve_raw(
 fn log_eve_wrapped(
     _tv: *mut ThreadVars,
     p: Option<Packet<'_>>,
-    f: *mut Flow,
+    f: Option<Flow<'_>>,
     jb: &mut JsonBuilder,
 ) -> Result<(), suricata_ffi::jsonbuilder::Error> {
     jb.open_object("rust_wrapped")?;
     jb.set_string("example", "eve-callback")?;
     jb.set_string("has_packet", if p.is_some() { "true" } else { "false" })?;
-    jb.set_string("has_flow", if f.is_null() { "false" } else { "true" })?;
+    jb.set_string("has_flow", if f.is_some() { "true" } else { "false" })?;
     jb.close()?;
     Ok(())
 }
 
-fn log_flow_init(_tv: *mut ThreadVars, f: *mut Flow, p: Option<Packet<'_>>) {
+fn log_flow_init(_tv: *mut ThreadVars, f: *mut RawFlow, p: Option<Packet<'_>>) {
     SCLogNotice!(
         "rust example flow init callback: flow={:p}, has_packet={}",
         f,
         p.is_some()
     );
 }
 
-fn log_flow_update(_tv: *mut ThreadVars, f: *mut Flow, p: Option<Packet<'_>>) {
+fn log_flow_update(_tv: *mut ThreadVars, f: *mut RawFlow, p: Option<Packet<'_>>) {
     SCLogNotice!(
         "rust example flow update callback: flow={:p}, has_packet={}",
         f,
         p.is_some()
     );
 }
 
-fn log_flow_finish(_tv: *mut ThreadVars, f: *mut Flow) {
+fn log_flow_finish(_tv: *mut ThreadVars, f: *mut RawFlow) {
     SCLogNotice!("rust example flow finish callback: flow={:p}", f);
 }
 

rust/ffi/src/eve.rs

@@ -19,7 +19,7 @@ use std::ffi::CString;
 use std::os::raw::c_void;
 
 pub use suricata_sys::sys::{
-    Flow, Packet as RawPacket, SCEveUserCallbackFn, SCJsonBuilder, ThreadVars,
+    Flow as RawFlow, Packet as RawPacket, SCEveUserCallbackFn, SCJsonBuilder, ThreadVars,
 };
 use suricata_sys::sys::{
     SCEveFileType, SCEveFileTypeDeinitFunc, SCEveFileTypeInitFunc, SCEveFileTypeThreadDeinitFunc,
@@ -82,7 +82,7 @@ impl EveFileType {
 /// The callback receives:
 /// - `tv`: the `ThreadVars` for the thread performing the logging
 /// - `p`: the `Packet`, or `None` if not available
-/// - `f`: the `Flow`, if available
+/// - `f`: the `Flow`, or `None` if not available
 /// - `jb`: the JSON builder for the current EVE record
 ///
 /// This API is intended for plugin and library users.
@@ -115,7 +115,7 @@ where
     F: for<'a> Fn(
             *mut ThreadVars,
             Option<crate::packet::Packet<'a>>,
-            *mut Flow,
+            Option<crate::flow::Flow<'a>>,
             &mut crate::jsonbuilder::JsonBuilder,
         ) -> Result<(), crate::jsonbuilder::Error>
         + Send
@@ -136,13 +136,13 @@ where
 /// Internal wrapper used to adapt the C EVE callback to a Rust
 /// closure callback.
 unsafe extern "C" fn callback_wrapper<F>(
-    tv: *mut ThreadVars, p: *const RawPacket, f: *mut Flow, jb: *mut SCJsonBuilder,
+    tv: *mut ThreadVars, p: *const RawPacket, f: *mut RawFlow, jb: *mut SCJsonBuilder,
     user: *mut c_void,
 ) where
     F: for<'a> Fn(
             *mut ThreadVars,
             Option<crate::packet::Packet<'a>>,
-            *mut Flow,
+            Option<crate::flow::Flow<'a>>,
             &mut crate::jsonbuilder::JsonBuilder,
         ) -> Result<(), crate::jsonbuilder::Error>
         + Send
@@ -157,7 +157,12 @@ unsafe extern "C" fn callback_wrapper<F>(
     } else {
         Some(crate::packet::Packet::from_ptr(p))
     };
-    if callback(tv, packet, f, &mut jb).is_err() {
+    let flow = if f.is_null() {
+        None
+    } else {
+        Some(crate::flow::Flow::from_ptr(f))
+    };
+    if callback(tv, packet, flow, &mut jb).is_err() {
         let _ = jb.restore_mark(&mark);
     }
 }