mirror of
https://github.com/zeek/zeek.git
synced 2025-10-09 01:58:20 +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
370
src/Frame.h
370
src/Frame.h
|
|
@ -17,250 +17,244 @@
|
|||
#include "zeek/ZeekArgs.h"
|
||||
#include "zeek/ZeekList.h" // for typedef val_list
|
||||
|
||||
namespace zeek
|
||||
{
|
||||
namespace zeek {
|
||||
|
||||
using ValPtr = IntrusivePtr<Val>;
|
||||
|
||||
namespace detail
|
||||
{
|
||||
namespace detail {
|
||||
|
||||
class CallExpr;
|
||||
class ScriptFunc;
|
||||
using IDPtr = IntrusivePtr<ID>;
|
||||
|
||||
namespace trigger
|
||||
{
|
||||
namespace trigger {
|
||||
|
||||
class Trigger;
|
||||
using TriggerPtr = IntrusivePtr<Trigger>;
|
||||
|
||||
}
|
||||
} // namespace trigger
|
||||
|
||||
class Frame;
|
||||
using FramePtr = IntrusivePtr<Frame>;
|
||||
|
||||
class Frame : public Obj
|
||||
{
|
||||
class Frame : public Obj {
|
||||
public:
|
||||
/**
|
||||
* Constructs a new frame belonging to *func* with *fn_args*
|
||||
* arguments.
|
||||
*
|
||||
* @param the size of the frame
|
||||
* @param func the function that is creating this frame
|
||||
* @param fn_args the arguments being passed to that function.
|
||||
*/
|
||||
Frame(int size, const ScriptFunc* func, const zeek::Args* fn_args);
|
||||
/**
|
||||
* Constructs a new frame belonging to *func* with *fn_args*
|
||||
* arguments.
|
||||
*
|
||||
* @param the size of the frame
|
||||
* @param func the function that is creating this frame
|
||||
* @param fn_args the arguments being passed to that function.
|
||||
*/
|
||||
Frame(int size, const ScriptFunc* func, const zeek::Args* fn_args);
|
||||
|
||||
/**
|
||||
* Returns the size of the frame.
|
||||
*
|
||||
* @return the number of elements in the frame.
|
||||
*/
|
||||
int FrameSize() const { return size; }
|
||||
/**
|
||||
* Returns the size of the frame.
|
||||
*
|
||||
* @return the number of elements in the frame.
|
||||
*/
|
||||
int FrameSize() const { return size; }
|
||||
|
||||
/**
|
||||
* @param n the index to get.
|
||||
* @return the value at index *n* of the underlying array.
|
||||
*/
|
||||
const ValPtr& GetElement(int n) const
|
||||
{
|
||||
// Note: technically this may want to adjust by current_offset, but
|
||||
// in practice, this method is never called from anywhere other than
|
||||
// function call invocation, where current_offset should be zero.
|
||||
return frame[n];
|
||||
}
|
||||
/**
|
||||
* @param n the index to get.
|
||||
* @return the value at index *n* of the underlying array.
|
||||
*/
|
||||
const ValPtr& GetElement(int n) const {
|
||||
// Note: technically this may want to adjust by current_offset, but
|
||||
// in practice, this method is never called from anywhere other than
|
||||
// function call invocation, where current_offset should be zero.
|
||||
return frame[n];
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the element at index *n* of the underlying array to *v*.
|
||||
* @param n the index to set
|
||||
* @param v the value to set it to
|
||||
*/
|
||||
void SetElement(int n, ValPtr v);
|
||||
/**
|
||||
* Sets the element at index *n* of the underlying array to *v*.
|
||||
* @param n the index to set
|
||||
* @param v the value to set it to
|
||||
*/
|
||||
void SetElement(int n, ValPtr v);
|
||||
|
||||
/**
|
||||
* Associates *id* and *v* in the frame. Future lookups of
|
||||
* *id* will return *v*.
|
||||
*
|
||||
* @param id the ID to associate
|
||||
* @param v the value to associate it with
|
||||
*/
|
||||
void SetElement(const ID* id, ValPtr v);
|
||||
void SetElement(const IDPtr& id, ValPtr v) { SetElement(id.get(), std::move(v)); }
|
||||
/**
|
||||
* Associates *id* and *v* in the frame. Future lookups of
|
||||
* *id* will return *v*.
|
||||
*
|
||||
* @param id the ID to associate
|
||||
* @param v the value to associate it with
|
||||
*/
|
||||
void SetElement(const ID* id, ValPtr v);
|
||||
void SetElement(const IDPtr& id, ValPtr v) { SetElement(id.get(), std::move(v)); }
|
||||
|
||||
/**
|
||||
* Gets the value associated with *id* and returns it. Returns
|
||||
* nullptr if no such element exists.
|
||||
*
|
||||
* @param id the id who's value to retrieve
|
||||
* @return the value associated with *id*
|
||||
*/
|
||||
const ValPtr& GetElementByID(const IDPtr& id) const { return GetElementByID(id.get()); }
|
||||
/**
|
||||
* Gets the value associated with *id* and returns it. Returns
|
||||
* nullptr if no such element exists.
|
||||
*
|
||||
* @param id the id who's value to retrieve
|
||||
* @return the value associated with *id*
|
||||
*/
|
||||
const ValPtr& GetElementByID(const IDPtr& id) const { return GetElementByID(id.get()); }
|
||||
|
||||
/**
|
||||
* Adjusts the current offset being used for frame accesses.
|
||||
* This is in support of inlined functions.
|
||||
*
|
||||
* @param incr Amount by which to increase the frame offset.
|
||||
* Use a negative value to shrink the offset.
|
||||
*/
|
||||
void AdjustOffset(int incr) { current_offset += incr; }
|
||||
/**
|
||||
* Adjusts the current offset being used for frame accesses.
|
||||
* This is in support of inlined functions.
|
||||
*
|
||||
* @param incr Amount by which to increase the frame offset.
|
||||
* Use a negative value to shrink the offset.
|
||||
*/
|
||||
void AdjustOffset(int incr) { current_offset += incr; }
|
||||
|
||||
/**
|
||||
* Resets all of the indexes from [*startIdx, frame_size) in
|
||||
* the Frame.
|
||||
* @param the first index to unref.
|
||||
*/
|
||||
void Reset(int startIdx);
|
||||
/**
|
||||
* Resets all of the indexes from [*startIdx, frame_size) in
|
||||
* the Frame.
|
||||
* @param the first index to unref.
|
||||
*/
|
||||
void Reset(int startIdx);
|
||||
|
||||
/**
|
||||
* Describes the frame and all of its values.
|
||||
*/
|
||||
void Describe(ODesc* d) const override;
|
||||
/**
|
||||
* Describes the frame and all of its values.
|
||||
*/
|
||||
void Describe(ODesc* d) const override;
|
||||
|
||||
/**
|
||||
* @return the function that the frame is associated with.
|
||||
*/
|
||||
const ScriptFunc* GetFunction() const { return function; }
|
||||
/**
|
||||
* @return the function that the frame is associated with.
|
||||
*/
|
||||
const ScriptFunc* GetFunction() const { return function; }
|
||||
|
||||
/**
|
||||
* @return the arguments passed to the function that this frame
|
||||
* is associated with.
|
||||
*/
|
||||
const Args* GetFuncArgs() const { return func_args; }
|
||||
/**
|
||||
* @return the arguments passed to the function that this frame
|
||||
* is associated with.
|
||||
*/
|
||||
const Args* GetFuncArgs() const { return func_args; }
|
||||
|
||||
/**
|
||||
* Change the function that the frame is associated with.
|
||||
*
|
||||
* @param func the function for the frame to be associated with.
|
||||
*/
|
||||
void SetFunction(ScriptFunc* func) { function = func; }
|
||||
/**
|
||||
* Change the function that the frame is associated with.
|
||||
*
|
||||
* @param func the function for the frame to be associated with.
|
||||
*/
|
||||
void SetFunction(ScriptFunc* func) { function = func; }
|
||||
|
||||
/**
|
||||
* Sets the next statement to be executed in the context of the frame.
|
||||
*
|
||||
* @param stmt the statement to set it to.
|
||||
*/
|
||||
void SetNextStmt(Stmt* stmt) { next_stmt = stmt; }
|
||||
/**
|
||||
* Sets the next statement to be executed in the context of the frame.
|
||||
*
|
||||
* @param stmt the statement to set it to.
|
||||
*/
|
||||
void SetNextStmt(Stmt* stmt) { next_stmt = stmt; }
|
||||
|
||||
/**
|
||||
* @return the next statement to be executed in the context of the frame.
|
||||
*/
|
||||
Stmt* GetNextStmt() const { return next_stmt; }
|
||||
/**
|
||||
* @return the next statement to be executed in the context of the frame.
|
||||
*/
|
||||
Stmt* GetNextStmt() const { return next_stmt; }
|
||||
|
||||
/** Used to implement "next" command in debugger. */
|
||||
void BreakBeforeNextStmt(bool should_break) { break_before_next_stmt = should_break; }
|
||||
bool BreakBeforeNextStmt() const { return break_before_next_stmt; }
|
||||
/** Used to implement "next" command in debugger. */
|
||||
void BreakBeforeNextStmt(bool should_break) { break_before_next_stmt = should_break; }
|
||||
bool BreakBeforeNextStmt() const { return break_before_next_stmt; }
|
||||
|
||||
/** Used to implement "finish" command in debugger. */
|
||||
void BreakOnReturn(bool should_break) { break_on_return = should_break; }
|
||||
bool BreakOnReturn() const { return break_on_return; }
|
||||
/** Used to implement "finish" command in debugger. */
|
||||
void BreakOnReturn(bool should_break) { break_on_return = should_break; }
|
||||
bool BreakOnReturn() const { return break_on_return; }
|
||||
|
||||
/**
|
||||
* Performs a deep copy of all the values in the current frame.
|
||||
*
|
||||
* @return a copy of this frame.
|
||||
*/
|
||||
Frame* Clone() const;
|
||||
/**
|
||||
* Performs a deep copy of all the values in the current frame.
|
||||
*
|
||||
* @return a copy of this frame.
|
||||
*/
|
||||
Frame* Clone() const;
|
||||
|
||||
/**
|
||||
* Creates a copy of the frame that just includes its trigger context.
|
||||
*
|
||||
* @return a partial copy of this frame.
|
||||
*/
|
||||
Frame* CloneForTrigger() const;
|
||||
/**
|
||||
* Creates a copy of the frame that just includes its trigger context.
|
||||
*
|
||||
* @return a partial copy of this frame.
|
||||
*/
|
||||
Frame* CloneForTrigger() const;
|
||||
|
||||
/**
|
||||
* Serializes the frame (only done for lambda/when captures) as a
|
||||
* sequence of two-element vectors, the first element reflecting
|
||||
* the frame value, the second its type.
|
||||
*/
|
||||
broker::expected<broker::data> Serialize();
|
||||
/**
|
||||
* Serializes the frame (only done for lambda/when captures) as a
|
||||
* sequence of two-element vectors, the first element reflecting
|
||||
* the frame value, the second its type.
|
||||
*/
|
||||
broker::expected<broker::data> Serialize();
|
||||
|
||||
/**
|
||||
* Instantiates a Frame from a serialized one.
|
||||
*
|
||||
* @return a pair in which the first item is the status of the serialization;
|
||||
* and the second is the unserialized frame with reference count +1, or
|
||||
* null if the serialization wasn't successful.
|
||||
*/
|
||||
static std::pair<bool, FramePtr> Unserialize(const broker::vector& data);
|
||||
/**
|
||||
* Instantiates a Frame from a serialized one.
|
||||
*
|
||||
* @return a pair in which the first item is the status of the serialization;
|
||||
* and the second is the unserialized frame with reference count +1, or
|
||||
* null if the serialization wasn't successful.
|
||||
*/
|
||||
static std::pair<bool, FramePtr> Unserialize(const broker::vector& data);
|
||||
|
||||
// If the frame is run in the context of a trigger condition evaluation,
|
||||
// the trigger needs to be registered.
|
||||
void SetTrigger(trigger::TriggerPtr arg_trigger);
|
||||
void ClearTrigger();
|
||||
trigger::Trigger* GetTrigger() const { return trigger.get(); }
|
||||
// If the frame is run in the context of a trigger condition evaluation,
|
||||
// the trigger needs to be registered.
|
||||
void SetTrigger(trigger::TriggerPtr arg_trigger);
|
||||
void ClearTrigger();
|
||||
trigger::Trigger* GetTrigger() const { return trigger.get(); }
|
||||
|
||||
void SetCall(const CallExpr* arg_call)
|
||||
{
|
||||
call = arg_call;
|
||||
SetTriggerAssoc((void*)call);
|
||||
}
|
||||
void SetOnlyCall(const CallExpr* arg_call) { call = arg_call; }
|
||||
const CallExpr* GetCall() const { return call; }
|
||||
void SetCall(const CallExpr* arg_call) {
|
||||
call = arg_call;
|
||||
SetTriggerAssoc((void*)call);
|
||||
}
|
||||
void SetOnlyCall(const CallExpr* arg_call) { call = arg_call; }
|
||||
const CallExpr* GetCall() const { return call; }
|
||||
|
||||
void SetTriggerAssoc(const void* arg_assoc) { assoc = arg_assoc; }
|
||||
const void* GetTriggerAssoc() const { return assoc; }
|
||||
void SetTriggerAssoc(const void* arg_assoc) { assoc = arg_assoc; }
|
||||
const void* GetTriggerAssoc() const { return assoc; }
|
||||
|
||||
const detail::Location* GetCallLocation() const;
|
||||
const detail::Location* GetCallLocation() const;
|
||||
|
||||
void SetDelayed() { delayed = true; }
|
||||
bool HasDelayed() const { return delayed; }
|
||||
void SetDelayed() { delayed = true; }
|
||||
bool HasDelayed() const { return delayed; }
|
||||
|
||||
private:
|
||||
using OffsetMap = std::unordered_map<std::string, int>;
|
||||
using OffsetMap = std::unordered_map<std::string, int>;
|
||||
|
||||
// This has a trivial form now, but used to hold additional
|
||||
// information, which is why we abstract it away from just being
|
||||
// a ValPtr.
|
||||
using Element = ValPtr;
|
||||
// This has a trivial form now, but used to hold additional
|
||||
// information, which is why we abstract it away from just being
|
||||
// a ValPtr.
|
||||
using Element = ValPtr;
|
||||
|
||||
const ValPtr& GetElementByID(const ID* id) const;
|
||||
const ValPtr& GetElementByID(const ID* id) const;
|
||||
|
||||
/** The number of vals that can be stored in this frame. */
|
||||
int size;
|
||||
/** The number of vals that can be stored in this frame. */
|
||||
int size;
|
||||
|
||||
bool break_before_next_stmt;
|
||||
bool break_on_return;
|
||||
bool delayed;
|
||||
bool break_before_next_stmt;
|
||||
bool break_on_return;
|
||||
bool delayed;
|
||||
|
||||
/** Associates ID's offsets with values. */
|
||||
std::unique_ptr<Element[]> frame;
|
||||
/** Associates ID's offsets with values. */
|
||||
std::unique_ptr<Element[]> frame;
|
||||
|
||||
/**
|
||||
* The offset we're currently using for references into the frame.
|
||||
* This is how we support inlined functions without having to
|
||||
* alter the offsets associated with their local variables.
|
||||
*/
|
||||
int current_offset;
|
||||
/**
|
||||
* The offset we're currently using for references into the frame.
|
||||
* This is how we support inlined functions without having to
|
||||
* alter the offsets associated with their local variables.
|
||||
*/
|
||||
int current_offset;
|
||||
|
||||
/** Frame used for lambda/when captures. */
|
||||
Frame* captures;
|
||||
/** Frame used for lambda/when captures. */
|
||||
Frame* captures;
|
||||
|
||||
/** Maps IDs to offsets into the "captures" frame. If the ID
|
||||
* isn't present, then it's not a capture.
|
||||
*/
|
||||
const OffsetMap* captures_offset_map;
|
||||
/** Maps IDs to offsets into the "captures" frame. If the ID
|
||||
* isn't present, then it's not a capture.
|
||||
*/
|
||||
const OffsetMap* captures_offset_map;
|
||||
|
||||
/** The function this frame is associated with. */
|
||||
const ScriptFunc* function;
|
||||
/** The function this frame is associated with. */
|
||||
const ScriptFunc* function;
|
||||
|
||||
// The following is only needed for the debugger.
|
||||
/** The arguments to the function that this Frame is associated with. */
|
||||
const zeek::Args* func_args;
|
||||
// The following is only needed for the debugger.
|
||||
/** The arguments to the function that this Frame is associated with. */
|
||||
const zeek::Args* func_args;
|
||||
|
||||
/** The next statement to be evaluated in the context of this frame. */
|
||||
Stmt* next_stmt;
|
||||
/** The next statement to be evaluated in the context of this frame. */
|
||||
Stmt* next_stmt;
|
||||
|
||||
trigger::TriggerPtr trigger;
|
||||
const CallExpr* call = nullptr;
|
||||
const void* assoc = nullptr;
|
||||
};
|
||||
trigger::TriggerPtr trigger;
|
||||
const CallExpr* call = nullptr;
|
||||
const void* assoc = nullptr;
|
||||
};
|
||||
|
||||
} // namespace detail
|
||||
} // namespace zeek
|
||||
} // namespace detail
|
||||
} // namespace zeek
|
||||
|
||||
/**
|
||||
* If we stopped using this and instead just made a struct of the information
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue