mirror of
https://github.com/zeek/zeek.git
synced 2025-10-10 02:28:21 +00:00
Reformat Zeek in Spicy style
This largely copies over Spicy's `.clang-format` configuration file. The one place where we deviate is header include order since Zeek depends on headers being included in a certain order.
This commit is contained in:
Benjamin Bannier
parent
7b8e7ed72c
commit
f5a76c1aed
786 changed files with 131714 additions and 153609 deletions
247
src/Trigger.h
247
src/Trigger.h
|
|
@ -11,16 +11,14 @@
|
|||
#include "zeek/iosource/IOSource.h"
|
||||
#include "zeek/util.h"
|
||||
|
||||
namespace zeek
|
||||
{
|
||||
namespace zeek {
|
||||
|
||||
class ODesc;
|
||||
class Val;
|
||||
|
||||
using ValPtr = IntrusivePtr<Val>;
|
||||
|
||||
namespace detail
|
||||
{
|
||||
namespace detail {
|
||||
|
||||
class Frame;
|
||||
class Stmt;
|
||||
|
|
@ -31,8 +29,7 @@ class WhenInfo;
|
|||
|
||||
using StmtPtr = IntrusivePtr<Stmt>;
|
||||
|
||||
namespace trigger
|
||||
{
|
||||
namespace trigger {
|
||||
|
||||
// Triggers are the heart of "when" statements: expressions that when
|
||||
// they become true execute a body of statements.
|
||||
|
|
@ -40,166 +37,162 @@ namespace trigger
|
|||
class TriggerTimer;
|
||||
class TriggerTraversalCallback;
|
||||
|
||||
class Trigger final : public Obj, public notifier::detail::Receiver
|
||||
{
|
||||
class Trigger final : public Obj, public notifier::detail::Receiver {
|
||||
public:
|
||||
// This first constructor can return an invalid pointer, so
|
||||
// its value must not be used further.
|
||||
[[deprecated("Remove in v7.1. Use second Trigger constructor via "
|
||||
"make_intrusive<...>.")]] Trigger(std::shared_ptr<WhenInfo> wi, double timeout,
|
||||
const IDSet& globals,
|
||||
std::vector<ValPtr> local_aggrs, Frame* f,
|
||||
const Location* loc);
|
||||
// This first constructor can return an invalid pointer, so
|
||||
// its value must not be used further.
|
||||
[[deprecated(
|
||||
"Remove in v7.1. Use second Trigger constructor via "
|
||||
"make_intrusive<...>.")]] Trigger(std::shared_ptr<WhenInfo> wi, double timeout, const IDSet& globals,
|
||||
std::vector<ValPtr> local_aggrs, Frame* f, const Location* loc);
|
||||
|
||||
// Use this constructor via make_intrusive<...>. The usual pattern is
|
||||
// to then discard what's returned, i.e. "(void)make_intrusive<...>" -
|
||||
// however, a valid pointer will be returned that can be used for
|
||||
// subsequent method calls.
|
||||
//
|
||||
// The reason for this complexity is that if the trigger condition
|
||||
// is true upon construction, after construction finishes there's
|
||||
// no more to do and the object should be deleted (Unref()'d).
|
||||
// If the condition is not true, then the constructor ensures that
|
||||
// the object will be tracked via sufficient Ref()'ing for further
|
||||
// processing and eventual deletion once the trigger is satisfied
|
||||
// or times out.
|
||||
//
|
||||
// Note that this constructor differs from the deprecated one only
|
||||
// in where the "timeout" parameter appears, and in making the "loc"
|
||||
// parameter optional. ("loc" is only used for internal logging when
|
||||
// debugging triggers.)
|
||||
Trigger(std::shared_ptr<WhenInfo> wi, const IDSet& globals, std::vector<ValPtr> local_aggrs,
|
||||
double timeout, Frame* f, const Location* loc = nullptr);
|
||||
// Use this constructor via make_intrusive<...>. The usual pattern is
|
||||
// to then discard what's returned, i.e. "(void)make_intrusive<...>" -
|
||||
// however, a valid pointer will be returned that can be used for
|
||||
// subsequent method calls.
|
||||
//
|
||||
// The reason for this complexity is that if the trigger condition
|
||||
// is true upon construction, after construction finishes there's
|
||||
// no more to do and the object should be deleted (Unref()'d).
|
||||
// If the condition is not true, then the constructor ensures that
|
||||
// the object will be tracked via sufficient Ref()'ing for further
|
||||
// processing and eventual deletion once the trigger is satisfied
|
||||
// or times out.
|
||||
//
|
||||
// Note that this constructor differs from the deprecated one only
|
||||
// in where the "timeout" parameter appears, and in making the "loc"
|
||||
// parameter optional. ("loc" is only used for internal logging when
|
||||
// debugging triggers.)
|
||||
Trigger(std::shared_ptr<WhenInfo> wi, const IDSet& globals, std::vector<ValPtr> local_aggrs, double timeout,
|
||||
Frame* f, const Location* loc = nullptr);
|
||||
|
||||
~Trigger() override;
|
||||
~Trigger() override;
|
||||
|
||||
// Evaluates the condition. If true, executes the body and deletes
|
||||
// the object deleted.
|
||||
//
|
||||
// Returns the state of condition.
|
||||
bool Eval();
|
||||
// Evaluates the condition. If true, executes the body and deletes
|
||||
// the object deleted.
|
||||
//
|
||||
// Returns the state of condition.
|
||||
bool Eval();
|
||||
|
||||
// Executes timeout code and deletes the object.
|
||||
void Timeout();
|
||||
// Executes timeout code and deletes the object.
|
||||
void Timeout();
|
||||
|
||||
// Return the timeout interval (negative if none was specified).
|
||||
double TimeoutValue() const { return timeout_value; }
|
||||
// Return the timeout interval (negative if none was specified).
|
||||
double TimeoutValue() const { return timeout_value; }
|
||||
|
||||
// Called if another entity needs to complete its operations first
|
||||
// in any case before this trigger can proceed.
|
||||
void Hold() { delayed = true; }
|
||||
// Called if another entity needs to complete its operations first
|
||||
// in any case before this trigger can proceed.
|
||||
void Hold() { delayed = true; }
|
||||
|
||||
// Complement of Hold().
|
||||
void Release() { delayed = false; }
|
||||
// Complement of Hold().
|
||||
void Release() { delayed = false; }
|
||||
|
||||
// If we evaluate to true, our return value will be passed on
|
||||
// to the given trigger. Note, automatically calls Hold().
|
||||
void Attach(Trigger* trigger);
|
||||
// If we evaluate to true, our return value will be passed on
|
||||
// to the given trigger. Note, automatically calls Hold().
|
||||
void Attach(Trigger* trigger);
|
||||
|
||||
// Cache for return values of delayed function calls. Returns whether
|
||||
// the trigger is queued for later evaluation -- it may not be queued
|
||||
// if the Val is null or it's disabled. The cache is managed using
|
||||
// void*'s so that the value can be associated with either a CallExpr
|
||||
// (for interpreted execution) or a C++ function (for compiled-to-C++).
|
||||
//
|
||||
// Lookup() returned value must be Ref()'d if you want to hang onto it.
|
||||
bool Cache(const void* obj, Val* val);
|
||||
Val* Lookup(const void* obj);
|
||||
// Cache for return values of delayed function calls. Returns whether
|
||||
// the trigger is queued for later evaluation -- it may not be queued
|
||||
// if the Val is null or it's disabled. The cache is managed using
|
||||
// void*'s so that the value can be associated with either a CallExpr
|
||||
// (for interpreted execution) or a C++ function (for compiled-to-C++).
|
||||
//
|
||||
// Lookup() returned value must be Ref()'d if you want to hang onto it.
|
||||
bool Cache(const void* obj, Val* val);
|
||||
Val* Lookup(const void* obj);
|
||||
|
||||
// Disable this trigger completely. Needed because Unref'ing the trigger
|
||||
// may not immediately delete it as other references may still exist.
|
||||
void Disable();
|
||||
// Disable this trigger completely. Needed because Unref'ing the trigger
|
||||
// may not immediately delete it as other references may still exist.
|
||||
void Disable();
|
||||
|
||||
bool Disabled() const { return disabled; }
|
||||
bool Disabled() const { return disabled; }
|
||||
|
||||
void Describe(ODesc* d) const override;
|
||||
void Describe(ODesc* d) const override;
|
||||
|
||||
// Overridden from Notifier. We queue the trigger and evaluate it
|
||||
// later to avoid race conditions.
|
||||
void Modified(zeek::notifier::detail::Modifiable* m) override;
|
||||
// Overridden from Notifier. We queue the trigger and evaluate it
|
||||
// later to avoid race conditions.
|
||||
void Modified(zeek::notifier::detail::Modifiable* m) override;
|
||||
|
||||
// Overridden from notifier::Receiver. If we're still waiting
|
||||
// on an ID/Val to be modified at termination time, we can't hope
|
||||
// for any further progress to be made, so just Unref ourselves.
|
||||
void Terminate() override;
|
||||
// Overridden from notifier::Receiver. If we're still waiting
|
||||
// on an ID/Val to be modified at termination time, we can't hope
|
||||
// for any further progress to be made, so just Unref ourselves.
|
||||
void Terminate() override;
|
||||
|
||||
const char* Name() const { return name.c_str(); }
|
||||
const char* Name() const { return name.c_str(); }
|
||||
|
||||
private:
|
||||
friend class TriggerTimer;
|
||||
friend class TriggerTimer;
|
||||
|
||||
void ReInit(std::vector<ValPtr> index_expr_results);
|
||||
void ReInit(std::vector<ValPtr> index_expr_results);
|
||||
|
||||
void Register(const ID* id);
|
||||
void Register(Val* val);
|
||||
void UnregisterAll();
|
||||
void Register(const ID* id);
|
||||
void Register(Val* val);
|
||||
void UnregisterAll();
|
||||
|
||||
ExprPtr cond;
|
||||
StmtPtr body;
|
||||
StmtPtr timeout_stmts;
|
||||
ExprPtr timeout;
|
||||
double timeout_value;
|
||||
Frame* frame;
|
||||
bool is_return;
|
||||
ExprPtr cond;
|
||||
StmtPtr body;
|
||||
StmtPtr timeout_stmts;
|
||||
ExprPtr timeout;
|
||||
double timeout_value;
|
||||
Frame* frame;
|
||||
bool is_return;
|
||||
|
||||
std::string name;
|
||||
std::string name;
|
||||
|
||||
TriggerTimer* timer;
|
||||
Trigger* attached;
|
||||
TriggerTimer* timer;
|
||||
Trigger* attached;
|
||||
|
||||
bool delayed; // true if a function call is currently being delayed
|
||||
bool disabled;
|
||||
bool delayed; // true if a function call is currently being delayed
|
||||
bool disabled;
|
||||
|
||||
// Globals and locals present in the when expression.
|
||||
IDSet globals;
|
||||
IDSet locals; // not needed, present only for matching deprecated logic
|
||||
// Globals and locals present in the when expression.
|
||||
IDSet globals;
|
||||
IDSet locals; // not needed, present only for matching deprecated logic
|
||||
|
||||
// Tracks whether we've found the globals/locals, as the work only
|
||||
// has to be done once.
|
||||
bool have_trigger_elems = false;
|
||||
// Tracks whether we've found the globals/locals, as the work only
|
||||
// has to be done once.
|
||||
bool have_trigger_elems = false;
|
||||
|
||||
// Aggregate values seen in locals used in the trigger condition,
|
||||
// so we can detect changes in them that affect whether the condition
|
||||
// holds.
|
||||
std::vector<ValPtr> local_aggrs;
|
||||
// Aggregate values seen in locals used in the trigger condition,
|
||||
// so we can detect changes in them that affect whether the condition
|
||||
// holds.
|
||||
std::vector<ValPtr> local_aggrs;
|
||||
|
||||
std::vector<std::pair<Obj*, notifier::detail::Modifiable*>> objs;
|
||||
std::vector<std::pair<Obj*, notifier::detail::Modifiable*>> objs;
|
||||
|
||||
using ValCache = std::map<const void*, Val*>;
|
||||
ValCache cache;
|
||||
};
|
||||
using ValCache = std::map<const void*, Val*>;
|
||||
ValCache cache;
|
||||
};
|
||||
|
||||
class Manager final : public iosource::IOSource
|
||||
{
|
||||
class Manager final : public iosource::IOSource {
|
||||
public:
|
||||
Manager();
|
||||
~Manager();
|
||||
Manager();
|
||||
~Manager();
|
||||
|
||||
void InitPostScript();
|
||||
void InitPostScript();
|
||||
|
||||
double GetNextTimeout() override;
|
||||
void Process() override;
|
||||
const char* Tag() override { return "TriggerMgr"; }
|
||||
double GetNextTimeout() override;
|
||||
void Process() override;
|
||||
const char* Tag() override { return "TriggerMgr"; }
|
||||
|
||||
void Queue(Trigger* trigger);
|
||||
void Queue(Trigger* trigger);
|
||||
|
||||
struct Stats
|
||||
{
|
||||
unsigned long total;
|
||||
unsigned long pending;
|
||||
};
|
||||
struct Stats {
|
||||
unsigned long total;
|
||||
unsigned long pending;
|
||||
};
|
||||
|
||||
void GetStats(Stats* stats);
|
||||
void GetStats(Stats* stats);
|
||||
|
||||
private:
|
||||
using TriggerList = std::list<Trigger*>;
|
||||
TriggerList* pending;
|
||||
unsigned long total_triggers = 0;
|
||||
};
|
||||
using TriggerList = std::list<Trigger*>;
|
||||
TriggerList* pending;
|
||||
unsigned long total_triggers = 0;
|
||||
};
|
||||
|
||||
} // namespace trigger
|
||||
} // namespace trigger
|
||||
|
||||
extern trigger::Manager* trigger_mgr;
|
||||
|
||||
} // namespace detail
|
||||
} // namespace zeek
|
||||
} // namespace detail
|
||||
} // namespace zeek
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue