Initial import of svn+ssh:://svn.icir.org/bro/trunk/bro as of r7088

src/Timer.h

@@ -0,0 +1,184 @@
+// $Id: Timer.h 6219 2008-10-01 05:39:07Z vern $
+//
+// See the file "COPYING" in the main distribution directory for copyright.
+
+#ifndef timer_h
+#define timer_h
+
+#include <string>
+
+#include <string>
+#include "SerialObj.h"
+#include "PriorityQueue.h"
+
+extern "C" {
+#include "cq.h"
+}
+
+// If you add a timer here, adjust TimerNames in Timer.cc.
+enum TimerType {
+	TIMER_BACKDOOR,
+	TIMER_BREAKPOINT,
+	TIMER_CONN_DELETE,
+	TIMER_CONN_EXPIRE,
+	TIMER_CONN_INACTIVITY,
+	TIMER_CONN_STATUS_UPDATE,
+	TIMER_DNS_EXPIRE,
+	TIMER_FRAG,
+	TIMER_INCREMENTAL_SEND,
+	TIMER_INCREMENTAL_WRITE,
+	TIMER_INTERCONN,
+	TIMER_NB_EXPIRE,
+	TIMER_NETWORK,
+	TIMER_NTP_EXPIRE,
+	TIMER_PROFILE,
+	TIMER_ROTATE,
+	TIMER_REMOVE_CONNECTION,
+	TIMER_RPC_EXPIRE,
+	TIMER_SCHEDULE,
+	TIMER_TABLE_VAL,
+	TIMER_TCP_ATTEMPT,
+	TIMER_TCP_DELETE,
+	TIMER_TCP_EXPIRE,
+	TIMER_TCP_PARTIAL_CLOSE,
+	TIMER_TCP_RESET,
+	TIMER_TRIGGER,
+	TIMER_TIMERMGR_EXPIRE,
+};
+const int NUM_TIMER_TYPES = int(TIMER_TIMERMGR_EXPIRE) + 1;
+
+extern const char* timer_type_to_string(TimerType type);
+
+class Serializer;
+class ODesc;
+
+class Timer : public SerialObj, public PQ_Element {
+public:
+	Timer(double t, TimerType arg_type) : PQ_Element(t)
+		{ type = (char) arg_type; }
+	virtual ~Timer()	{ }
+
+	TimerType Type() const	{ return (TimerType) type; }
+
+	// t gives the dispatch time.  is_expire is true if the
+	// timer is being dispatched because we're expiring all
+	// pending timers.
+	virtual void Dispatch(double t, int is_expire) = 0;
+
+	void Describe(ODesc* d) const;
+
+	bool Serialize(SerialInfo* info) const;
+	static Timer* Unserialize(UnserialInfo* info);
+
+protected:
+	Timer()	{}
+
+	DECLARE_ABSTRACT_SERIAL(Timer);
+
+	unsigned int type:8;
+};
+
+class TimerMgr {
+public:
+	virtual ~TimerMgr();
+
+	virtual void Add(Timer* timer) = 0;
+
+	// Advance the clock to time t, expiring at most max_expire timers.
+	// Returns number of timers expired.
+	int Advance(double t, int max_expire);
+
+	// Returns the number of timers expired (so far) during the current
+	// or most recent advance.
+	int NumExpiredDuringCurrentAdvance()	{ return num_expired; }
+
+	// Expire all timers.
+	virtual void Expire() = 0;
+
+	// Cancel() is a method separate from Remove because
+	// (1) Remove is protected, but, more importantly, (2) in some
+	// timer schemes we have wound up separating timer cancelation
+	// from removing it from the manager's data structures, because
+	// the manager lacked an efficient way to find it.
+	void Cancel(Timer* timer)	{ Remove(timer); }
+
+	double Time() const		{ return t ? t : 1; }	// 1 > 0
+
+ 	typedef std::string Tag;
+ 	const Tag& GetTag() const 	{ return tag; }
+
+	virtual int Size() const = 0;
+	virtual int PeakSize() const = 0;
+
+	double LastTimestamp() const	{ return last_timestamp; }
+	// Returns time of last advance in global network time.
+	double LastAdvance() const	{ return last_advance; }
+	
+	static unsigned int* CurrentTimers()	{ return current_timers; }
+
+protected:
+ 	TimerMgr(const Tag& arg_tag)
+ 		{
+ 		t = 0.0;
+ 		num_expired = 0;
+ 		last_advance = last_timestamp = 0;
+ 		tag = arg_tag;
+ 		}
+
+	virtual int DoAdvance(double t, int max_expire) = 0;
+	virtual void Remove(Timer* timer) = 0;
+
+	double t;
+	double last_timestamp;
+	double last_advance;
+	Tag tag;
+
+	int num_expired;
+
+	static unsigned int current_timers[NUM_TIMER_TYPES];
+};
+
+class PQ_TimerMgr : public TimerMgr {
+public:
+	PQ_TimerMgr(const Tag& arg_tag);
+	~PQ_TimerMgr();
+
+	void Add(Timer* timer);
+	void Expire();
+
+	int Size() const	{ return q->Size(); }
+	int PeakSize() const	{ return q->PeakSize(); }
+	unsigned int MemoryUsage() const;
+
+protected:
+	int DoAdvance(double t, int max_expire);
+	void Remove(Timer* timer);
+
+	Timer* Remove()			{ return (Timer*) q->Remove(); }
+	Timer* Top()			{ return (Timer*) q->Top(); }
+
+	PriorityQueue* q;
+};
+
+class CQ_TimerMgr : public TimerMgr {
+public:
+	CQ_TimerMgr(const Tag& arg_tag);
+	~CQ_TimerMgr();
+
+	void Add(Timer* timer);
+	void Expire();
+
+	int Size() const	{ return cq_size(cq); }
+	int PeakSize() const	{ return cq_max_size(cq); }
+	unsigned int MemoryUsage() const;
+
+protected:
+	int DoAdvance(double t, int max_expire);
+	void Remove(Timer* timer);
+
+	struct cq_handle *cq;
+};
+
+extern TimerMgr* timer_mgr;
+
+#endif