Merge remote-tracking branch 'origin/topic/timw/std-function-event-handler'

* origin/topic/timw/std-function-event-handler:
  Add a method to register an event handler to a std::function via C++

CHANGES

@@ -1,3 +1,7 @@
+7.0.0-dev.78 | 2024-03-18 16:37:46 -0700
+
+  * Add a method to register an event handler to a std::function via C++ (Tim Wojtulewicz, Corelight)
+
 7.0.0-dev.76 | 2024-03-18 16:15:44 -0700
 
   * Update Broker submodule (Dominik Charousset, Corelight)

VERSION

@@ -1 +1 @@
-7.0.0-dev.76
+7.0.0-dev.78

src/EventRegistry.h

@@ -12,6 +12,7 @@
 #include <vector>
 
 #include "zeek/IntrusivePtr.h"
+#include "zeek/ZeekArgs.h"
 
 namespace zeek {
 

src/Func.cc

@@ -143,6 +143,11 @@ void Func::AddBody(detail::StmtPtr /* new_body */, const std::vector<detail::IDP
     Internal("Func::AddBody called");
 }
 
+void Func::AddBody(detail::StdFunctionStmt::FunctionVariant body, int priority) {
+    auto stmt = zeek::make_intrusive<detail::StdFunctionStmt>(std::move(body));
+    AddBody(stmt, {}, priority);
+}
+
 void Func::SetScope(detail::ScopePtr newscope) { scope = std::move(newscope); }
 
 FuncPtr Func::DoClone() {

src/Func.h

@@ -114,6 +114,7 @@ public:
     void AddBody(detail::StmtPtr new_body, const std::vector<detail::IDPtr>& new_inits, size_t new_frame_size,
                  int priority = 0);
     void AddBody(detail::StmtPtr new_body, size_t new_frame_size);
+    void AddBody(detail::StdFunctionStmt::FunctionVariant body, int priority = 0);
 
     virtual void SetScope(detail::ScopePtr newscope);
     virtual detail::ScopePtr GetScope() const { return scope; }

src/Stmt.cc

@@ -53,6 +53,7 @@ const char* stmt_name(StmtTag t) {
         "null",
         "assert",
         "extern",
+        "std-function",
     };
 
 #pragma GCC diagnostic push
@@ -2083,4 +2084,17 @@ TraversalCode WhenStmt::Traverse(TraversalCallback* cb) const {
     HANDLE_TC_STMT_POST(tc);
 }
 
+ValPtr StdFunctionStmt::Exec(Frame* f, StmtFlowType& flow) {
+    zeek::Args args = *f->GetFuncArgs();
+
+    if ( func.index() == 0 ) {
+        flow = FLOW_NEXT;
+        std::get<0>(func)(args);
+    }
+    else
+        std::get<1>(func)(args, flow);
+
+    return nullptr;
+}
+
 } // namespace zeek::detail

src/Stmt.h

@@ -780,4 +780,25 @@ protected:
     int expected_len;
 };
 
+// Statement that calls a std::function. These can be added to a Func body
+// to directly all a C++ method.
+class StdFunctionStmt : public Stmt {
+public:
+    using FunctionVariant =
+        std::variant<std::function<void(const zeek::Args&)>, std::function<void(const zeek::Args&, StmtFlowType&)>>;
+    StdFunctionStmt(FunctionVariant f) : Stmt(STMT_STD_FUNCTION), func(std::move(f)) {}
+
+    ValPtr Exec(Frame* f, StmtFlowType& flow) override;
+
+    StmtPtr Duplicate() override {
+        reporter->Error("Duplicate() on StdFunctionStmt not implemented");
+        return {zeek::NewRef{}, this};
+    }
+
+    TraversalCode Traverse(TraversalCallback* cb) const override { return TC_CONTINUE; }
+
+private:
+    FunctionVariant func;
+};
+
 } // namespace zeek::detail

src/StmtEnums.h

@@ -31,8 +31,9 @@ enum StmtTag {
     STMT_ZAM,           // a ZAM function body
     STMT_NULL,
     STMT_ASSERT,
-    STMT_EXTERN, // for custom Stmt subclasses provided by plugins
+    STMT_EXTERN,       // for custom Stmt subclasses provided by plugins
-#define NUM_STMTS (int(STMT_EXTERN) + 1)
+    STMT_STD_FUNCTION, // statements that call a std::function from c++
+#define NUM_STMTS (int(STMT_STD_FUNCTION) + 1)
 };
 
 enum StmtFlowType {

testing/btest/Baseline/plugins.protocol/output

@@ -4,6 +4,10 @@ Demo::Foo - A Foo test analyzer (dynamic, version 1.0.0)
     [Event] foo_message
 
 ===
+c++ connection_established lambda handler, received 1 arguments
+c++ connection_established member handler, received 1 arguments
 foo_message, [orig_h=::1, orig_p=37927/tcp, resp_h=::1, resp_p=4242/tcp], Hello, Foo!\x0a
 ===
+c++ connection_established lambda handler, received 1 arguments
+c++ connection_established member handler, received 1 arguments
 foo_message, [orig_h=::1, orig_p=37927/tcp, resp_h=::1, resp_p=4243/tcp], Hello, Foo!\x0a

testing/btest/plugins/protocol-plugin/src/Foo.cc

@@ -1,19 +1,34 @@
 
 #include "Foo.h"
 
+#include "zeek/EventRegistry.h"
 #include "zeek/analyzer/protocol/tcp/TCP_Reassembler.h"
 
 #include "events.bif.h"
 #include "foo_pac.h"
 
 using namespace btest::plugin::Demo_Foo;
+using namespace std::placeholders;
 
 Foo::Foo(zeek::Connection* conn) : zeek::analyzer::tcp::TCP_ApplicationAnalyzer("Foo", conn) {
     interp = new binpac::Foo::Foo_Conn(this);
+
+    auto handler = zeek::event_registry->Lookup("connection_established");
+    if ( handler ) {
+        handler->GetFunc()->AddBody([](const zeek::Args& args) {
+            printf("c++ connection_established lambda handler, received %zu arguments\n", args.size());
+        });
+
+        handler->GetFunc()->AddBody(std::bind(&Foo::ConnectionEstablishedHandler, this, _1));
+    }
 }
 
 Foo::~Foo() { delete interp; }
 
+void Foo::ConnectionEstablishedHandler(const zeek::Args& args) {
+    printf("c++ connection_established member handler, received %zu arguments\n", args.size());
+}
+
 void Foo::Done() {
     zeek::analyzer::tcp::TCP_ApplicationAnalyzer::Done();
 

testing/btest/plugins/protocol-plugin/src/Foo.h

@@ -23,6 +23,7 @@ public:
     virtual void EndpointEOF(bool is_orig);
 
     static zeek::analyzer::Analyzer* Instantiate(zeek::Connection* conn) { return new Foo(conn); }
+    void ConnectionEstablishedHandler(const zeek::Args& args);
 
 protected:
     binpac::Foo::Foo_Conn* interp;