mirror of
https://github.com/zeek/zeek.git
synced 2025-10-08 09:38:19 +00:00
6fa03abdbc
* origin/topic/gilbert/plugin-api-tweak: Updating plugin.hooks baseline so that test succeeds Revert spacing change that shouldn't have been included with the previous changeset ... should fix all of the plugin tests save hooks, which needs to be updated. More small fixes Small fixes Incremental Re-updating plugin.hooks test to include new argument output (after merge). Fixing logic errors in HandlePluginResult Updating tests and tweaking HookArgument to include Frame support. Incremental commit: implementing a wrapper for the Val class. Reverting change to const status of network_time. Also, see FIXME: in Func.cc / HandlePluginResult ... Tweaks to result handling to make things a little more sane. Plugin API: minor change (adding parent frame) to support calling methods from hook. Also declare network time update argument to be const because good practice. BIT-1270 #merged Conflicts: testing/btest/Baseline/plugins.hooks/output
151 lines
3.7 KiB
C++
151 lines
3.7 KiB
C++
// See the file "COPYING" in the main distribution directory for copyright.
|
|
|
|
#ifndef func_h
|
|
#define func_h
|
|
|
|
#include <utility>
|
|
|
|
#include "BroList.h"
|
|
#include "Obj.h"
|
|
#include "Debug.h"
|
|
|
|
class Val;
|
|
class ListExpr;
|
|
class FuncType;
|
|
class Stmt;
|
|
class Frame;
|
|
class ID;
|
|
class CallExpr;
|
|
|
|
class Func : public BroObj {
|
|
public:
|
|
|
|
enum Kind { BRO_FUNC, BUILTIN_FUNC };
|
|
|
|
Func(Kind arg_kind);
|
|
|
|
virtual ~Func();
|
|
|
|
virtual int IsPure() const = 0;
|
|
function_flavor Flavor() const { return FType()->Flavor(); }
|
|
|
|
struct Body {
|
|
Stmt* stmts;
|
|
int priority;
|
|
bool operator<(const Body& other) const
|
|
{ return priority > other.priority; } // reverse sort
|
|
};
|
|
|
|
const vector<Body>& GetBodies() const { return bodies; }
|
|
bool HasBodies() const { return bodies.size(); }
|
|
|
|
// virtual Val* Call(ListExpr* args) const = 0;
|
|
virtual Val* Call(val_list* args, Frame* parent = 0) const = 0;
|
|
|
|
// Add a new event handler to an existing function (event).
|
|
virtual void AddBody(Stmt* new_body, id_list* new_inits,
|
|
int new_frame_size, int priority = 0);
|
|
|
|
virtual void SetScope(Scope* newscope) { scope = newscope; }
|
|
virtual Scope* GetScope() const { return scope; }
|
|
|
|
virtual FuncType* FType() const { return type->AsFuncType(); }
|
|
|
|
Kind GetKind() const { return kind; }
|
|
|
|
const char* Name() const { return name.c_str(); }
|
|
void SetName(const char* arg_name) { name = arg_name; }
|
|
|
|
virtual void Describe(ODesc* d) const = 0;
|
|
virtual void DescribeDebug(ODesc* d, const val_list* args) const;
|
|
|
|
// This (un-)serializes only a single body (as given in SerialInfo).
|
|
bool Serialize(SerialInfo* info) const;
|
|
static Func* Unserialize(UnserialInfo* info);
|
|
|
|
virtual TraversalCode Traverse(TraversalCallback* cb) const;
|
|
|
|
uint32 GetUniqueFuncID() const { return unique_id; }
|
|
static Func* GetFuncPtrByID(uint32 id)
|
|
{ return id >= unique_ids.size() ? 0 : unique_ids[id]; }
|
|
|
|
protected:
|
|
Func();
|
|
|
|
// Helper function for handling result of plugin hook.
|
|
std::pair<bool, Val*> HandlePluginResult(std::pair<bool, Val*> plugin_result, val_list* args, function_flavor flavor) const;
|
|
|
|
DECLARE_ABSTRACT_SERIAL(Func);
|
|
|
|
vector<Body> bodies;
|
|
Scope* scope;
|
|
Kind kind;
|
|
BroType* type;
|
|
string name;
|
|
uint32 unique_id;
|
|
static vector<Func*> unique_ids;
|
|
};
|
|
|
|
|
|
class BroFunc : public Func {
|
|
public:
|
|
BroFunc(ID* id, Stmt* body, id_list* inits, int frame_size, int priority);
|
|
~BroFunc();
|
|
|
|
int IsPure() const;
|
|
Val* Call(val_list* args, Frame* parent) const;
|
|
|
|
void AddBody(Stmt* new_body, id_list* new_inits, int new_frame_size,
|
|
int priority);
|
|
|
|
int FrameSize() const { return frame_size; }
|
|
|
|
void Describe(ODesc* d) const;
|
|
|
|
protected:
|
|
BroFunc() : Func(BRO_FUNC) {}
|
|
Stmt* AddInits(Stmt* body, id_list* inits);
|
|
|
|
DECLARE_SERIAL(BroFunc);
|
|
|
|
int frame_size;
|
|
};
|
|
|
|
typedef Val* (*built_in_func)(Frame* frame, val_list* args);
|
|
|
|
class BuiltinFunc : public Func {
|
|
public:
|
|
BuiltinFunc(built_in_func func, const char* name, int is_pure);
|
|
~BuiltinFunc();
|
|
|
|
int IsPure() const;
|
|
Val* Call(val_list* args, Frame* parent) const;
|
|
built_in_func TheFunc() const { return func; }
|
|
|
|
void Describe(ODesc* d) const;
|
|
|
|
protected:
|
|
BuiltinFunc() { func = 0; is_pure = 0; }
|
|
|
|
DECLARE_SERIAL(BuiltinFunc);
|
|
|
|
built_in_func func;
|
|
int is_pure;
|
|
};
|
|
|
|
|
|
extern void builtin_error(const char* msg, BroObj* arg = 0);
|
|
extern void init_builtin_funcs();
|
|
extern void init_builtin_funcs_subdirs();
|
|
|
|
extern bool check_built_in_call(BuiltinFunc* f, CallExpr* call);
|
|
|
|
// This global is set prior to the interpreter making a function call.
|
|
// It's there so that built-in functions can access the location information
|
|
// associated with a call when reporting error messages.
|
|
extern const Expr* calling_expr;
|
|
|
|
// This is set to true after the built-in functions have been initialized.
|
|
extern bool did_builtin_init;
|
|
|
|
#endif
|