eventq: Major API change for the Event and EventQueue structures.

Since the early days of M5, an event needed to know which event queue
it was on, and that data was required at the time of construction of
the event object.  In the future parallelized M5, this sort of
requirement does not work well since the proper event queue will not
always be known at the time of construction of an event.  Now, events
are created, and the EventQueue itself has the schedule function,
e.g. eventq->schedule(event, when).  To simplify the syntax, I created
a class called EventManager which holds a pointer to an EventQueue and
provides the schedule interface that is a proxy for the EventQueue.
The intent is that objects that frequently schedule events can be
derived from EventManager and then they have the schedule interface.
SimObject and Port are examples of objects that will become
EventManagers.  The end result is that any SimObject can just call
schedule(event, when) and it will just call that SimObject's
eventq->schedule function.  Of course, some objects may have more than
one EventQueue, so this interface might not be perfect for those, but
they should be relatively few.

src/python/m5/event.py

@@ -26,17 +26,32 @@
 #
 # Authors: Nathan Binkert
 
-from internal.event import create
-from internal.event import SimLoopExitEvent as SimExit
+import internal.event
 
-class ProgressEvent(object):
-    def __init__(self, period):
+from internal.event import PythonEvent, SimLoopExitEvent as SimExit
+
+mainq = internal.event.cvar.mainEventQueue
+
+def create(obj, priority=None):
+    if priority is None:
+        priority = internal.event.Event.Default_Pri
+    return internal.event.PythonEvent(obj, priority)
+
+class Event(PythonEvent):
+    def __init__(self, priority=None):
+        if priority is None:
+            priority = internal.event.Event.Default_Pri
+        super(PythonEvent, self).__init__(self, priority)
+
+class ProgressEvent(Event):
+    def __init__(self, eventq, period):
+        super(ProgressEvent, self).__init__()
         self.period = int(period)
-        self.schedule()
-
-    def schedule(self):
-        create(self, m5.curTick() + self.period)
+        self.eventq = eventq
+        self.eventq.schedule(self, m5.curTick() + self.period)
 
     def __call__(self):
         print "Progress! Time now %fs" % (m5.curTick()/1e12)
-        self.schedule()
+        self.eventq.schedule(self, m5.curTick() + self.period)
+
+__all__ = [ 'create', 'Event', 'ProgressEvent', 'SimExit', 'mainq' ]

src/python/swig/event.i

@@ -32,34 +32,36 @@
 
 %{
 #include "python/swig/pyevent.hh"
-
+#include "sim/host.hh"
+#include "sim/eventq.hh"
 #include "sim/sim_events.hh"
 #include "sim/sim_exit.hh"
 #include "sim/simulate.hh"
 %}
 
+#pragma SWIG nowarn=350,351
+
+%import "base/fast_alloc.hh"
+%import "sim/serialize.hh"
+
 %include "stdint.i"
 %include "std_string.i"
 %include "sim/host.hh"
+%include "sim/eventq.hh"
+%include "python/swig/pyevent.hh"
 
-void create(PyObject *object, Tick when);
-
-class Event;
-class CountedDrainEvent : public Event {
-  public:
+struct CountedDrainEvent : public Event
+{
     void setCount(int _count);
 };
 
-CountedDrainEvent *createCountedDrain();
-void cleanupCountedDrain(Event *drain_event);
-
 // minimal definition of SimExitEvent interface to wrap
-class SimLoopExitEvent {
+class SimLoopExitEvent : public Event
+{
   public:
     std::string getCause();
     int getCode();
-    SimLoopExitEvent(EventQueue *q, Tick _when, Tick _repeat,
-                     const std::string &_cause, int c = 0);
+    SimLoopExitEvent(const std::string &_cause, int c, Tick _repeat = 0);
 };
 
 %exception simulate {

src/python/swig/pyevent.cc

@@ -33,8 +33,8 @@
 #include "python/swig/pyevent.hh"
 #include "sim/async.hh"
 
-PythonEvent::PythonEvent(PyObject *obj, Tick when, Priority priority)
-    : Event(&mainEventQueue, priority), object(obj)
+PythonEvent::PythonEvent(PyObject *obj, Priority priority)
+    : Event(priority), object(obj)
 {
     if (object == NULL)
         panic("Passed in invalid object");
@@ -42,7 +42,6 @@ PythonEvent::PythonEvent(PyObject *obj, Tick when, Priority priority)
     Py_INCREF(object);
 
     setFlags(AutoDelete);
-    schedule(when);
 }
 
 PythonEvent::~PythonEvent()
@@ -67,3 +66,36 @@ PythonEvent::process()
         async_exception = true;
     }
 }
+
+Event *
+createCountedDrain()
+{
+    return new CountedDrainEvent();
+}
+
+void
+cleanupCountedDrain(Event *counted_drain)
+{
+    CountedDrainEvent *event =
+        dynamic_cast<CountedDrainEvent *>(counted_drain);
+    if (event == NULL) {
+        fatal("Called cleanupCountedDrain() on an event that was not "
+              "a CountedDrainEvent.");
+    }
+    assert(event->getCount() == 0);
+    delete event;
+}
+
+#if 0
+Event *
+create(PyObject *object, Event::Priority priority)
+{
+    return new PythonEvent(object, priority);
+}
+
+void
+destroy(Event *event)
+{
+    delete event;
+}
+#endif

src/python/swig/pyevent.hh

@@ -40,35 +40,13 @@ class PythonEvent : public Event
     PyObject *object;
 
   public:
-    PythonEvent(PyObject *obj, Tick when, Priority priority = Default_Pri);
+    PythonEvent(PyObject *obj, Event::Priority priority);
     ~PythonEvent();
 
     virtual void process();
 };
 
-inline void
-create(PyObject *object, Tick when)
-{
-    new PythonEvent(object, when);
-}
-
-inline Event *
-createCountedDrain()
-{
-    return new CountedDrainEvent();
-}
-
-inline void
-cleanupCountedDrain(Event *counted_drain)
-{
-    CountedDrainEvent *event =
-        dynamic_cast<CountedDrainEvent *>(counted_drain);
-    if (event == NULL) {
-        fatal("Called cleanupCountedDrain() on an event that was not "
-              "a CountedDrainEvent.");
-    }
-    assert(event->getCount() == 0);
-    delete event;
-}
+Event *createCountedDrain();
+void cleanupCountedDrain(Event *counted_drain);
 
 #endif // __PYTHON_SWIG_PYEVENT_HH__