Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-04 15:48:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Reformat the world

Browse source
This commit is contained in:
Tim Wojtulewicz 2021-09-16 15:35:39 -07:00
parent 194cb24547
commit b2f171ec69
714 changed files with 35149 additions and 35203 deletions
Download patch file Download diff file Expand all files Collapse all files

102
src/threading/MsgThread.h
View file

@ -3,19 +3,21 @@
#include <atomic>
#include "zeek/DebugLogger.h"
#include "zeek/Flare.h"
#include "zeek/iosource/IOSource.h"
#include "zeek/threading/BasicThread.h"
#include "zeek/threading/Queue.h"
#include "zeek/iosource/IOSource.h"
#include "zeek/Flare.h"
namespace zeek::threading {
namespace zeek::threading
{
struct Value;
struct Field;
class BasicInputMessage;
class BasicOutputMessage;
namespace detail {
namespace detail
{
// These classes are marked as friends later so they need to be forward declared.
class HeartbeatMessage;
@ -23,7 +25,7 @@ class FinishMessage;
class FinishedMessage;
class KillMeMessage;
}
}
/**
* A specialized thread that provides bi-directional message passing between
@ -37,7 +39,7 @@ class KillMeMessage;
* processes all remaining ones still in the queue, and then exits.
*/
class MsgThread : public BasicThread, public iosource::IOSource
{
{
public:
/**
* Constructor. It automatically registers the thread with the
@ -60,7 +62,7 @@ public:
*
* @param msg The message.
*/
void SendIn(BasicInputMessage* msg) { return SendIn(msg, false); }
void SendIn(BasicInputMessage* msg) { return SendIn(msg, false); }
/**
* Sends a message from the child thread to the main thread.
@ -69,7 +71,7 @@ public:
*
* @param msg The mesasge.
*/
void SendOut(BasicOutputMessage* msg) { return SendOut(msg, false); }
void SendOut(BasicOutputMessage* msg) { return SendOut(msg, false); }
/**
* Allows the child thread to send a specified Zeek event. The given Vals
@ -81,7 +83,7 @@ public:
*
* @param vals the values to be given to the event
*/
void SendEvent(const char* name, const int num_vals, Value* *vals);
void SendEvent(const char* name, const int num_vals, Value** vals);
/**
* Reports an informational message from the child thread. The main
@ -187,14 +189,15 @@ public:
*/
struct Stats
{
uint64_t sent_in; //! Number of messages sent to the child thread.
uint64_t sent_out; //! Number of messages sent from the child thread to the main thread
uint64_t pending_in; //! Number of messages sent to the child but not yet processed.
uint64_t pending_out; //! Number of messages sent from the child but not yet processed by the main thread.
uint64_t sent_in; //! Number of messages sent to the child thread.
uint64_t sent_out; //! Number of messages sent from the child thread to the main thread
uint64_t pending_in; //! Number of messages sent to the child but not yet processed.
uint64_t pending_out; //! Number of messages sent from the child but not yet processed by
//! the main thread.
/// Statistics from our queues.
Queue<BasicInputMessage *>::Stats queue_in_stats;
Queue<BasicOutputMessage *>::Stats queue_out_stats;
Queue<BasicInputMessage*>::Stats queue_in_stats;
Queue<BasicOutputMessage*>::Stats queue_out_stats;
};
/**
@ -243,9 +246,9 @@ protected:
virtual void Heartbeat();
/** Returns true if a child command has reported a failure. In that case, we'll
* be in the process of killing this thread and no further activity
* should carried out. To be called only from this child thread.
*/
* be in the process of killing this thread and no further activity
* should carried out. To be called only from this child thread.
*/
bool Failed() const { return failed; }
/**
@ -314,13 +317,13 @@ private:
* Returns true if there's at least one message pending for the child
* thread.
*/
bool HasIn() { return queue_in.Ready(); }
bool HasIn() { return queue_in.Ready(); }
/**
* Returns true if there's at least one message pending for the main
* thread.
*/
bool HasOut() { return queue_out.Ready(); }
bool HasOut() { return queue_out.Ready(); }
/**
* Returns true if there might be at least one message pending for
@ -334,25 +337,26 @@ private:
*/
void Finished();
Queue<BasicInputMessage *> queue_in;
Queue<BasicOutputMessage *> queue_out;
Queue<BasicInputMessage*> queue_in;
Queue<BasicOutputMessage*> queue_out;
std::atomic<uint64_t> cnt_sent_in; // Counts message sent to child.
std::atomic<uint64_t> cnt_sent_out; // Counts message sent by child.
std::atomic<uint64_t> cnt_sent_in; // Counts message sent to child.
std::atomic<uint64_t> cnt_sent_out; // Counts message sent by child.
bool main_finished; // Main thread is finished, meaning child_finished propagated back through message queue.
bool child_finished; // Child thread is finished.
bool main_finished; // Main thread is finished, meaning child_finished propagated back through
// message queue.
bool child_finished; // Child thread is finished.
bool child_sent_finish; // Child thread asked to be finished.
bool failed; // Set to true when a command failed.
bool failed; // Set to true when a command failed.
zeek::detail::Flare flare;
};
};
/**
* Base class for all message between Bro's main process and a MsgThread.
*/
class Message
{
{
public:
/**
* Destructor.
@ -378,18 +382,17 @@ protected:
* @param arg_name A descriptive name for the type of message. Used
* mainly for debugging purposes.
*/
explicit Message(const char* arg_name)
{ name = util::copy_string(arg_name); }
explicit Message(const char* arg_name) { name = util::copy_string(arg_name); }
private:
const char* name;
};
};
/**
* Base class for messages sent from Bro's main thread to a child MsgThread.
*/
class BasicInputMessage : public Message
{
{
protected:
/**
* Constructor.
@ -397,14 +400,14 @@ protected:
* @param name A descriptive name for the type of message. Used
* mainly for debugging purposes.
*/
explicit BasicInputMessage(const char* name) : Message(name) {}
};
explicit BasicInputMessage(const char* name) : Message(name) { }
};
/**
* Base class for messages sent from a child MsgThread to Bro's main thread.
*/
class BasicOutputMessage : public Message
{
{
protected:
/**
* Constructor.
@ -412,16 +415,15 @@ protected:
* @param name A descriptive name for the type of message. Used
* mainly for debugging purposes.
*/
explicit BasicOutputMessage(const char* name) : Message(name) {}
};
explicit BasicOutputMessage(const char* name) : Message(name) { }
};
/**
* A parameterized InputMessage that stores a pointer to an argument object.
* Normally, the objects will be used from the Process() callback.
*/
template<typename O>
class InputMessage : public BasicInputMessage
{
template <typename O> class InputMessage : public BasicInputMessage
{
public:
/**
* Returns the objects passed to the constructor.
@ -437,20 +439,18 @@ protected:
*
* @param arg_object: An object to store with the message.
*/
InputMessage(const char* name, O* arg_object) : BasicInputMessage(name)
{ object = arg_object; }
InputMessage(const char* name, O* arg_object) : BasicInputMessage(name) { object = arg_object; }
private:
O* object;
};
};
/**
* A parameterized OutputMessage that stores a pointer to an argument object.
* Normally, the objects will be used from the Process() callback.
*/
template<typename O>
class OutputMessage : public BasicOutputMessage
{
template <typename O> class OutputMessage : public BasicOutputMessage
{
public:
/**
* Returns the objects passed to the constructor.
@ -467,10 +467,12 @@ protected:
* @param arg_object An object to store with the message.
*/
OutputMessage(const char* name, O* arg_object) : BasicOutputMessage(name)
{ object = arg_object; }
{
object = arg_object;
}
private:
O* object;
};
};
} // namespace zeek::threading
} // namespace zeek::threading