ARM: Implement WFE/WFI/SEV semantics.
[gem5.git] / src / sim / eventq.hh
index d9ca02768c50daeeb2609247de3030d270a94921..fcfa119c4d7e48973c23f3d585030e8fcd3c0ff6 100644 (file)
@@ -47,6 +47,7 @@
 #include "base/misc.hh"
 #include "base/trace.hh"
 #include "base/types.hh"
+#include "debug/Event.hh"
 #include "sim/serialize.hh"
 
 class EventQueue;       // forward declaration
@@ -68,17 +69,25 @@ class Event : public Serializable, public FastAlloc
     typedef short FlagsType;
     typedef ::Flags<FlagsType> Flags;
 
-    static const FlagsType PublicRead    = 0x003f;
-    static const FlagsType PublicWrite   = 0x001d;
-    static const FlagsType Squashed      = 0x0001;
-    static const FlagsType Scheduled     = 0x0002;
-    static const FlagsType AutoDelete    = 0x0004;
-    static const FlagsType AutoSerialize = 0x0008;
-    static const FlagsType IsExitEvent   = 0x0010;
-    static const FlagsType IsMainQueue   = 0x0020;
-#ifdef EVENTQ_DEBUG
-    static const FlagsType Initialized   = 0xf000;
-#endif
+    static const FlagsType PublicRead    = 0x003f; // public readable flags
+    static const FlagsType PublicWrite   = 0x001d; // public writable flags
+    static const FlagsType Squashed      = 0x0001; // has been squashed
+    static const FlagsType Scheduled     = 0x0002; // has been scheduled
+    static const FlagsType AutoDelete    = 0x0004; // delete after dispatch
+    static const FlagsType AutoSerialize = 0x0008; // must be serialized
+    static const FlagsType IsExitEvent   = 0x0010; // special exit event
+    static const FlagsType IsMainQueue   = 0x0020; // on main event queue
+    static const FlagsType Initialized   = 0x7a40; // somewhat random bits
+    static const FlagsType InitMask      = 0xffc0; // mask for init bits
+
+    bool
+    initialized() const
+    {
+        return this && (flags & InitMask) == Initialized;
+    }
+
+  public:
+    typedef int8_t Priority;
 
   private:
     // The event queue is now a linked list of linked lists.  The
@@ -97,7 +106,7 @@ class Event : public Serializable, public FastAlloc
     static Event *removeItem(Event *event, Event *last);
 
     Tick _when;         //!< timestamp when event should be processed
-    short _priority;    //!< event priority
+    Priority _priority; //!< event priority
     Flags flags;
 
 #ifndef NDEBUG
@@ -128,7 +137,7 @@ class Event : public Serializable, public FastAlloc
         queue = q;
 #endif
 #ifdef EVENTQ_DEBUG
-        whenScheduled = curTick;
+        whenScheduled = curTick();
 #endif
     }
 
@@ -143,7 +152,7 @@ class Event : public Serializable, public FastAlloc
     Flags
     getFlags(Flags _flags) const
     {
-        assert(flags.noneSet(~PublicRead));
+        assert(_flags.noneSet(~PublicRead));
         return flags.isSet(_flags);
     }
 
@@ -183,72 +192,70 @@ class Event : public Serializable, public FastAlloc
     /// at the same cycle.  Most events are scheduled at the default
     /// priority; these values are used to control events that need to
     /// be ordered within a cycle.
-    enum Priority {
-        /// Minimum priority
-        Minimum_Pri             = SHRT_MIN,
-
-        /// If we enable tracing on a particular cycle, do that as the
-        /// very first thing so we don't miss any of the events on
-        /// that cycle (even if we enter the debugger).
-        Trace_Enable_Pri        = -101,
-
-        /// Breakpoints should happen before anything else (except
-        /// enabling trace output), so we don't miss any action when
-        /// debugging.
-        Debug_Break_Pri         = -100,
-
-        /// CPU switches schedule the new CPU's tick event for the
-        /// same cycle (after unscheduling the old CPU's tick event).
-        /// The switch needs to come before any tick events to make
-        /// sure we don't tick both CPUs in the same cycle.
-        CPU_Switch_Pri          =   -31,
-
-        /// For some reason "delayed" inter-cluster writebacks are
-        /// scheduled before regular writebacks (which have default
-        /// priority).  Steve?
-        Delayed_Writeback_Pri   =   -1,
-
-        /// Default is zero for historical reasons.
-        Default_Pri             =    0,
-
-        /// Serailization needs to occur before tick events also, so
-        /// that a serialize/unserialize is identical to an on-line
-        /// CPU switch.
-        Serialize_Pri           =   32,
-
-        /// CPU ticks must come after other associated CPU events
-        /// (such as writebacks).
-        CPU_Tick_Pri            =   50,
-
-        /// Statistics events (dump, reset, etc.) come after
-        /// everything else, but before exit.
-        Stat_Event_Pri          =   90,
-
-        /// Progress events come at the end.
-        Progress_Event_Pri      =   95,
-
-        /// If we want to exit on this cycle, it's the very last thing
-        /// we do.
-        Sim_Exit_Pri            =  100,
-
-        /// Maximum priority
-        Maximum_Pri             = SHRT_MAX
-    };
+
+    /// Minimum priority
+    static const Priority Minimum_Pri =          SCHAR_MIN;
+
+    /// If we enable tracing on a particular cycle, do that as the
+    /// very first thing so we don't miss any of the events on
+    /// that cycle (even if we enter the debugger).
+    static const Priority Trace_Enable_Pri =          -101;
+
+    /// Breakpoints should happen before anything else (except
+    /// enabling trace output), so we don't miss any action when
+    /// debugging.
+    static const Priority Debug_Break_Pri =           -100;
+
+    /// CPU switches schedule the new CPU's tick event for the
+    /// same cycle (after unscheduling the old CPU's tick event).
+    /// The switch needs to come before any tick events to make
+    /// sure we don't tick both CPUs in the same cycle.
+    static const Priority CPU_Switch_Pri =             -31;
+
+    /// For some reason "delayed" inter-cluster writebacks are
+    /// scheduled before regular writebacks (which have default
+    /// priority).  Steve?
+    static const Priority Delayed_Writeback_Pri =       -1;
+
+    /// Default is zero for historical reasons.
+    static const Priority Default_Pri =                  0;
+
+    /// Serailization needs to occur before tick events also, so
+    /// that a serialize/unserialize is identical to an on-line
+    /// CPU switch.
+    static const Priority Serialize_Pri =               32;
+
+    /// CPU ticks must come after other associated CPU events
+    /// (such as writebacks).
+    static const Priority CPU_Tick_Pri =                50;
+
+    /// Statistics events (dump, reset, etc.) come after
+    /// everything else, but before exit.
+    static const Priority Stat_Event_Pri =              90;
+
+    /// Progress events come at the end.
+    static const Priority Progress_Event_Pri =          95;
+
+    /// If we want to exit on this cycle, it's the very last thing
+    /// we do.
+    static const Priority Sim_Exit_Pri =               100;
+
+    /// Maximum priority
+    static const Priority Maximum_Pri =          SCHAR_MAX;
 
     /*
      * Event constructor
      * @param queue that the event gets scheduled on
      */
     Event(Priority p = Default_Pri)
-        : nextBin(NULL), nextInBin(NULL), _priority(p)
+        : nextBin(NULL), nextInBin(NULL), _priority(p), flags(Initialized)
     {
 #ifndef NDEBUG
         instance = ++instanceCounter;
         queue = NULL;
 #endif
 #ifdef EVENTQ_DEBUG
-        flags.set(Initialized);
-        whenCreated = curTick;
+        whenCreated = curTick();
         whenScheduled = 0;
 #endif
     }
@@ -293,7 +300,7 @@ class Event : public Serializable, public FastAlloc
     Tick when() const { return _when; }
 
     /// Get the event priority
-    int priority() const { return _priority; }
+    Priority priority() const { return _priority; }
 
 #ifndef SWIG
     struct priority_compare
@@ -364,10 +371,11 @@ class EventQueue : public Serializable
     void insert(Event *event);
     void remove(Event *event);
 
+    EventQueue(const EventQueue &);
+    const EventQueue &operator=(const EventQueue &);
+
   public:
-    EventQueue(const std::string &n)
-        : objName(n), head(NULL)
-    {}
+    EventQueue(const std::string &n);
 
     virtual const std::string name() const { return objName; }
 
@@ -398,15 +406,15 @@ class EventQueue : public Serializable
         }
     }
 
-    // default: process all events up to 'now' (curTick)
-    void serviceEvents() { serviceEvents(curTick); }
+    // default: process all events up to 'now' (curTick())
+    void serviceEvents() { serviceEvents(curTick()); }
 
     // return true if no events are queued
     bool empty() const { return head == NULL; }
 
     void dump() const;
 
-    Tick nextEventTime() { return empty() ? curTick : head->when(); }
+    Tick nextEventTime() { return empty() ? curTick() : head->when(); }
 
     bool debugVerify() const;
 
@@ -434,6 +442,11 @@ class EventManager
         return eventq;
     }
 
+    operator EventQueue *() const
+    {
+        return eventq;
+    }
+
     void
     schedule(Event &event, Tick when)
     {
@@ -474,11 +487,11 @@ class EventManager
 inline void
 EventQueue::schedule(Event *event, Tick when)
 {
-    assert((UTick)when >= (UTick)curTick);
+    // Typecasting Tick->Utick here since gcc
+    // complains about signed overflow
+    assert((UTick)when >= (UTick)curTick());
     assert(!event->scheduled());
-#ifdef EVENTQ_DEBUG
-    assert((event->flags & Event::Initialized) == Event::Initialized);
-#endif
+    assert(event->initialized());
 
     event->setWhen(when, this);
     insert(event);
@@ -496,9 +509,7 @@ inline void
 EventQueue::deschedule(Event *event)
 {
     assert(event->scheduled());
-#ifdef EVENTQ_DEBUG
-    assert((event->flags & Event::Initialized) == Event::Initialized);
-#endif
+    assert(event->initialized());
 
     remove(event);
 
@@ -515,11 +526,11 @@ EventQueue::deschedule(Event *event)
 inline void
 EventQueue::reschedule(Event *event, Tick when, bool always)
 {
-    assert(when >= curTick);
+    // Typecasting Tick->Utick here since gcc
+    // complains about signed overflow
+    assert((UTick)when >= (UTick)curTick());
     assert(always || event->scheduled());
-#ifdef EVENTQ_DEBUG
-    assert((event->flags & Event::Initialized) == Event::Initialized);
-#endif
+    assert(event->initialized());
 
     if (event->scheduled())
         remove(event);
@@ -571,6 +582,13 @@ class EventWrapper : public Event
             setFlags(AutoDelete);
     }
 
+    EventWrapper(T &obj, bool del = false, Priority p = Default_Pri)
+        : Event(p), object(&obj)
+    {
+        if (del)
+            setFlags(AutoDelete);
+    }
+
     void process() { (object->*F)(); }
 
     const std::string