eventq.hh revision 10153
12SN/A/* 21762SN/A * Copyright (c) 2000-2005 The Regents of The University of Michigan 39983Sstever@gmail.com * Copyright (c) 2013 Advanced Micro Devices, Inc. 49983Sstever@gmail.com * Copyright (c) 2013 Mark D. Hill and David A. Wood 52SN/A * All rights reserved. 62SN/A * 72SN/A * Redistribution and use in source and binary forms, with or without 82SN/A * modification, are permitted provided that the following conditions are 92SN/A * met: redistributions of source code must retain the above copyright 102SN/A * notice, this list of conditions and the following disclaimer; 112SN/A * redistributions in binary form must reproduce the above copyright 122SN/A * notice, this list of conditions and the following disclaimer in the 132SN/A * documentation and/or other materials provided with the distribution; 142SN/A * neither the name of the copyright holders nor the names of its 152SN/A * contributors may be used to endorse or promote products derived from 162SN/A * this software without specific prior written permission. 172SN/A * 182SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 192SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 202SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 212SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 222SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 232SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 242SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 252SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 262SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 272SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 282SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 292665Ssaidi@eecs.umich.edu * 302665Ssaidi@eecs.umich.edu * Authors: Steve Reinhardt 312665Ssaidi@eecs.umich.edu * Nathan Binkert 322SN/A */ 332SN/A 342SN/A/* @file 352SN/A * EventQueue interfaces 362SN/A */ 372SN/A 381354SN/A#ifndef __SIM_EVENTQ_HH__ 391354SN/A#define __SIM_EVENTQ_HH__ 402SN/A 412SN/A#include <algorithm> 425501Snate@binkert.org#include <cassert> 435546Snate@binkert.org#include <climits> 447004Snate@binkert.org#include <iosfwd> 459983Sstever@gmail.com#include <mutex> 462SN/A#include <string> 472SN/A 485769Snate@binkert.org#include "base/flags.hh" 492361SN/A#include "base/misc.hh" 506216Snate@binkert.org#include "base/types.hh" 518232Snate@binkert.org#include "debug/Event.hh" 5256SN/A#include "sim/serialize.hh" 532SN/A 545543Ssaidi@eecs.umich.educlass EventQueue; // forward declaration 559983Sstever@gmail.comclass BaseGlobalEvent; 562SN/A 579983Sstever@gmail.com//! Simulation Quantum for multiple eventq simulation. 589983Sstever@gmail.com//! The quantum value is the period length after which the queues 599983Sstever@gmail.com//! synchronize themselves with each other. This means that any 609983Sstever@gmail.com//! event to scheduled on Queue A which is generated by an event on 619983Sstever@gmail.com//! Queue B should be at least simQuantum ticks away in future. 629983Sstever@gmail.comextern Tick simQuantum; 631354SN/A 649983Sstever@gmail.com//! Current number of allocated main event queues. 659983Sstever@gmail.comextern uint32_t numMainEventQueues; 669983Sstever@gmail.com 679983Sstever@gmail.com//! Array for main event queues. 689983Sstever@gmail.comextern std::vector<EventQueue *> mainEventQueue; 699983Sstever@gmail.com 709983Sstever@gmail.com#ifndef SWIG 719983Sstever@gmail.com//! The current event queue for the running thread. Access to this queue 729983Sstever@gmail.com//! does not require any locking from the thread. 739983Sstever@gmail.com 749983Sstever@gmail.comextern __thread EventQueue *_curEventQueue; 759983Sstever@gmail.com 769983Sstever@gmail.com#endif 779983Sstever@gmail.com 789983Sstever@gmail.com//! Current mode of execution: parallel / serial 799983Sstever@gmail.comextern bool inParallelMode; 809983Sstever@gmail.com 819983Sstever@gmail.com//! Function for returning eventq queue for the provided 829983Sstever@gmail.com//! index. The function allocates a new queue in case one 839983Sstever@gmail.com//! does not exist for the index, provided that the index 849983Sstever@gmail.com//! is with in bounds. 859983Sstever@gmail.comEventQueue *getEventQueue(uint32_t index); 869983Sstever@gmail.com 879983Sstever@gmail.cominline EventQueue *curEventQueue() { return _curEventQueue; } 889983Sstever@gmail.cominline void curEventQueue(EventQueue *q) { _curEventQueue = q; } 899983Sstever@gmail.com 909983Sstever@gmail.com/** 919983Sstever@gmail.com * Common base class for Event and GlobalEvent, so they can share flag 929983Sstever@gmail.com * and priority definitions and accessor functions. This class should 939983Sstever@gmail.com * not be used directly. 942SN/A */ 959983Sstever@gmail.comclass EventBase 962SN/A{ 975769Snate@binkert.org protected: 988902Sandreas.hansson@arm.com typedef unsigned short FlagsType; 995769Snate@binkert.org typedef ::Flags<FlagsType> Flags; 1005769Snate@binkert.org 1017059Snate@binkert.org static const FlagsType PublicRead = 0x003f; // public readable flags 1027059Snate@binkert.org static const FlagsType PublicWrite = 0x001d; // public writable flags 1037059Snate@binkert.org static const FlagsType Squashed = 0x0001; // has been squashed 1047059Snate@binkert.org static const FlagsType Scheduled = 0x0002; // has been scheduled 1057059Snate@binkert.org static const FlagsType AutoDelete = 0x0004; // delete after dispatch 1067059Snate@binkert.org static const FlagsType AutoSerialize = 0x0008; // must be serialized 1077059Snate@binkert.org static const FlagsType IsExitEvent = 0x0010; // special exit event 1087059Snate@binkert.org static const FlagsType IsMainQueue = 0x0020; // on main event queue 1097059Snate@binkert.org static const FlagsType Initialized = 0x7a40; // somewhat random bits 1107059Snate@binkert.org static const FlagsType InitMask = 0xffc0; // mask for init bits 1117059Snate@binkert.org 1127058Snate@binkert.org public: 1137058Snate@binkert.org typedef int8_t Priority; 1147058Snate@binkert.org 115396SN/A /// Event priorities, to provide tie-breakers for events scheduled 116396SN/A /// at the same cycle. Most events are scheduled at the default 117396SN/A /// priority; these values are used to control events that need to 118396SN/A /// be ordered within a cycle. 1195501Snate@binkert.org 1207058Snate@binkert.org /// Minimum priority 1217058Snate@binkert.org static const Priority Minimum_Pri = SCHAR_MIN; 1223329Sstever@eecs.umich.edu 1237058Snate@binkert.org /// If we enable tracing on a particular cycle, do that as the 1247058Snate@binkert.org /// very first thing so we don't miss any of the events on 1257058Snate@binkert.org /// that cycle (even if we enter the debugger). 1269979Satgutier@umich.edu static const Priority Debug_Enable_Pri = -101; 127396SN/A 1287058Snate@binkert.org /// Breakpoints should happen before anything else (except 1297058Snate@binkert.org /// enabling trace output), so we don't miss any action when 1307058Snate@binkert.org /// debugging. 1317058Snate@binkert.org static const Priority Debug_Break_Pri = -100; 1323329Sstever@eecs.umich.edu 1337058Snate@binkert.org /// CPU switches schedule the new CPU's tick event for the 1347058Snate@binkert.org /// same cycle (after unscheduling the old CPU's tick event). 1357058Snate@binkert.org /// The switch needs to come before any tick events to make 1367058Snate@binkert.org /// sure we don't tick both CPUs in the same cycle. 1377058Snate@binkert.org static const Priority CPU_Switch_Pri = -31; 138396SN/A 1397058Snate@binkert.org /// For some reason "delayed" inter-cluster writebacks are 1407058Snate@binkert.org /// scheduled before regular writebacks (which have default 1417058Snate@binkert.org /// priority). Steve? 1427058Snate@binkert.org static const Priority Delayed_Writeback_Pri = -1; 143396SN/A 1447058Snate@binkert.org /// Default is zero for historical reasons. 1457058Snate@binkert.org static const Priority Default_Pri = 0; 146396SN/A 1477058Snate@binkert.org /// Serailization needs to occur before tick events also, so 1487058Snate@binkert.org /// that a serialize/unserialize is identical to an on-line 1497058Snate@binkert.org /// CPU switch. 1507058Snate@binkert.org static const Priority Serialize_Pri = 32; 151396SN/A 1527058Snate@binkert.org /// CPU ticks must come after other associated CPU events 1537058Snate@binkert.org /// (such as writebacks). 1547058Snate@binkert.org static const Priority CPU_Tick_Pri = 50; 155396SN/A 1567058Snate@binkert.org /// Statistics events (dump, reset, etc.) come after 1577058Snate@binkert.org /// everything else, but before exit. 1587058Snate@binkert.org static const Priority Stat_Event_Pri = 90; 1594075Sbinkertn@umich.edu 1607058Snate@binkert.org /// Progress events come at the end. 1617058Snate@binkert.org static const Priority Progress_Event_Pri = 95; 1625501Snate@binkert.org 1637058Snate@binkert.org /// If we want to exit on this cycle, it's the very last thing 1647058Snate@binkert.org /// we do. 1657058Snate@binkert.org static const Priority Sim_Exit_Pri = 100; 1667058Snate@binkert.org 1677058Snate@binkert.org /// Maximum priority 1687058Snate@binkert.org static const Priority Maximum_Pri = SCHAR_MAX; 1699983Sstever@gmail.com}; 1709983Sstever@gmail.com 1719983Sstever@gmail.com/* 1729983Sstever@gmail.com * An item on an event queue. The action caused by a given 1739983Sstever@gmail.com * event is specified by deriving a subclass and overriding the 1749983Sstever@gmail.com * process() member function. 1759983Sstever@gmail.com * 1769983Sstever@gmail.com * Caution, the order of members is chosen to maximize data packing. 1779983Sstever@gmail.com */ 1789983Sstever@gmail.comclass Event : public EventBase, public Serializable 1799983Sstever@gmail.com{ 1809983Sstever@gmail.com friend class EventQueue; 1819983Sstever@gmail.com 1829983Sstever@gmail.com private: 1839983Sstever@gmail.com // The event queue is now a linked list of linked lists. The 1849983Sstever@gmail.com // 'nextBin' pointer is to find the bin, where a bin is defined as 1859983Sstever@gmail.com // when+priority. All events in the same bin will be stored in a 1869983Sstever@gmail.com // second linked list (a stack) maintained by the 'nextInBin' 1879983Sstever@gmail.com // pointer. The list will be accessed in LIFO order. The end 1889983Sstever@gmail.com // result is that the insert/removal in 'nextBin' is 1899983Sstever@gmail.com // linear/constant, and the lookup/removal in 'nextInBin' is 1909983Sstever@gmail.com // constant/constant. Hopefully this is a significant improvement 1919983Sstever@gmail.com // over the current fully linear insertion. 1929983Sstever@gmail.com Event *nextBin; 1939983Sstever@gmail.com Event *nextInBin; 1949983Sstever@gmail.com 1959983Sstever@gmail.com static Event *insertBefore(Event *event, Event *curr); 1969983Sstever@gmail.com static Event *removeItem(Event *event, Event *last); 1979983Sstever@gmail.com 1989983Sstever@gmail.com Tick _when; //!< timestamp when event should be processed 1999983Sstever@gmail.com Priority _priority; //!< event priority 2009983Sstever@gmail.com Flags flags; 2019983Sstever@gmail.com 2029983Sstever@gmail.com#ifndef NDEBUG 2039983Sstever@gmail.com /// Global counter to generate unique IDs for Event instances 2049983Sstever@gmail.com static Counter instanceCounter; 2059983Sstever@gmail.com 2069983Sstever@gmail.com /// This event's unique ID. We can also use pointer values for 2079983Sstever@gmail.com /// this but they're not consistent across runs making debugging 2089983Sstever@gmail.com /// more difficult. Thus we use a global counter value when 2099983Sstever@gmail.com /// debugging. 2109983Sstever@gmail.com Counter instance; 2119983Sstever@gmail.com 2129983Sstever@gmail.com /// queue to which this event belongs (though it may or may not be 2139983Sstever@gmail.com /// scheduled on this queue yet) 2149983Sstever@gmail.com EventQueue *queue; 2159983Sstever@gmail.com#endif 2169983Sstever@gmail.com 2179983Sstever@gmail.com#ifdef EVENTQ_DEBUG 2189983Sstever@gmail.com Tick whenCreated; //!< time created 2199983Sstever@gmail.com Tick whenScheduled; //!< time scheduled 2209983Sstever@gmail.com#endif 2219983Sstever@gmail.com 2229983Sstever@gmail.com void 2239983Sstever@gmail.com setWhen(Tick when, EventQueue *q) 2249983Sstever@gmail.com { 2259983Sstever@gmail.com _when = when; 2269983Sstever@gmail.com#ifndef NDEBUG 2279983Sstever@gmail.com queue = q; 2289983Sstever@gmail.com#endif 2299983Sstever@gmail.com#ifdef EVENTQ_DEBUG 2309983Sstever@gmail.com whenScheduled = curTick(); 2319983Sstever@gmail.com#endif 2329983Sstever@gmail.com } 2339983Sstever@gmail.com 2349983Sstever@gmail.com bool 2359983Sstever@gmail.com initialized() const 2369983Sstever@gmail.com { 2379983Sstever@gmail.com return this && (flags & InitMask) == Initialized; 2389983Sstever@gmail.com } 2399983Sstever@gmail.com 2409983Sstever@gmail.com protected: 2419983Sstever@gmail.com /// Accessor for flags. 2429983Sstever@gmail.com Flags 2439983Sstever@gmail.com getFlags() const 2449983Sstever@gmail.com { 2459983Sstever@gmail.com return flags & PublicRead; 2469983Sstever@gmail.com } 2479983Sstever@gmail.com 2489983Sstever@gmail.com bool 2499983Sstever@gmail.com isFlagSet(Flags _flags) const 2509983Sstever@gmail.com { 2519983Sstever@gmail.com assert(_flags.noneSet(~PublicRead)); 2529983Sstever@gmail.com return flags.isSet(_flags); 2539983Sstever@gmail.com } 2549983Sstever@gmail.com 2559983Sstever@gmail.com /// Accessor for flags. 2569983Sstever@gmail.com void 2579983Sstever@gmail.com setFlags(Flags _flags) 2589983Sstever@gmail.com { 2599983Sstever@gmail.com assert(_flags.noneSet(~PublicWrite)); 2609983Sstever@gmail.com flags.set(_flags); 2619983Sstever@gmail.com } 2629983Sstever@gmail.com 2639983Sstever@gmail.com void 2649983Sstever@gmail.com clearFlags(Flags _flags) 2659983Sstever@gmail.com { 2669983Sstever@gmail.com assert(_flags.noneSet(~PublicWrite)); 2679983Sstever@gmail.com flags.clear(_flags); 2689983Sstever@gmail.com } 2699983Sstever@gmail.com 2709983Sstever@gmail.com void 2719983Sstever@gmail.com clearFlags() 2729983Sstever@gmail.com { 2739983Sstever@gmail.com flags.clear(PublicWrite); 2749983Sstever@gmail.com } 2759983Sstever@gmail.com 2769983Sstever@gmail.com // This function isn't really useful if TRACING_ON is not defined 2779983Sstever@gmail.com virtual void trace(const char *action); //!< trace event activity 2789983Sstever@gmail.com 2799983Sstever@gmail.com public: 280396SN/A 2812SN/A /* 2822SN/A * Event constructor 2832SN/A * @param queue that the event gets scheduled on 2842SN/A */ 2858581Ssteve.reinhardt@amd.com Event(Priority p = Default_Pri, Flags f = 0) 2868581Ssteve.reinhardt@amd.com : nextBin(NULL), nextInBin(NULL), _priority(p), 2878581Ssteve.reinhardt@amd.com flags(Initialized | f) 288224SN/A { 2898581Ssteve.reinhardt@amd.com assert(f.noneSet(~PublicWrite)); 2904016Sstever@eecs.umich.edu#ifndef NDEBUG 2915501Snate@binkert.org instance = ++instanceCounter; 2925605Snate@binkert.org queue = NULL; 2935501Snate@binkert.org#endif 2945501Snate@binkert.org#ifdef EVENTQ_DEBUG 2957823Ssteve.reinhardt@amd.com whenCreated = curTick(); 2965501Snate@binkert.org whenScheduled = 0; 2974016Sstever@eecs.umich.edu#endif 298224SN/A } 299224SN/A 3005768Snate@binkert.org virtual ~Event(); 3015768Snate@binkert.org virtual const std::string name() const; 302265SN/A 3035501Snate@binkert.org /// Return a C string describing the event. This string should 3045501Snate@binkert.org /// *not* be dynamically allocated; just a const char array 3055501Snate@binkert.org /// describing the event class. 3065501Snate@binkert.org virtual const char *description() const; 3075501Snate@binkert.org 3085501Snate@binkert.org /// Dump the current event data 3095501Snate@binkert.org void dump() const; 3105501Snate@binkert.org 3115501Snate@binkert.org public: 3125501Snate@binkert.org /* 3135501Snate@binkert.org * This member function is invoked when the event is processed 3145501Snate@binkert.org * (occurs). There is no default implementation; each subclass 3155501Snate@binkert.org * must provide its own implementation. The event is not 3165501Snate@binkert.org * automatically deleted after it is processed (to allow for 3175501Snate@binkert.org * statically allocated event objects). 3185501Snate@binkert.org * 3195501Snate@binkert.org * If the AutoDestroy flag is set, the object is deleted once it 3205501Snate@binkert.org * is processed. 3215501Snate@binkert.org */ 3225501Snate@binkert.org virtual void process() = 0; 3235501Snate@binkert.org 3242SN/A /// Determine if the current event is scheduled 3255769Snate@binkert.org bool scheduled() const { return flags.isSet(Scheduled); } 3262SN/A 3272SN/A /// Squash the current event 3285769Snate@binkert.org void squash() { flags.set(Squashed); } 3292SN/A 3302SN/A /// Check whether the event is squashed 3315769Snate@binkert.org bool squashed() const { return flags.isSet(Squashed); } 3322SN/A 3332667Sstever@eecs.umich.edu /// See if this is a SimExitEvent (without resorting to RTTI) 3345769Snate@binkert.org bool isExitEvent() const { return flags.isSet(IsExitEvent); } 3352667Sstever@eecs.umich.edu 3362SN/A /// Get the time that the event is scheduled 3372SN/A Tick when() const { return _when; } 3382SN/A 3392SN/A /// Get the event priority 3407058Snate@binkert.org Priority priority() const { return _priority; } 3412SN/A 3429983Sstever@gmail.com //! If this is part of a GlobalEvent, return the pointer to the 3439983Sstever@gmail.com //! Global Event. By default, there is no GlobalEvent, so return 3449983Sstever@gmail.com //! NULL. (Overridden in GlobalEvent::BarrierEvent.) 3459983Sstever@gmail.com virtual BaseGlobalEvent *globalEvent() { return NULL; } 3469983Sstever@gmail.com 3475605Snate@binkert.org#ifndef SWIG 348224SN/A virtual void serialize(std::ostream &os); 349237SN/A virtual void unserialize(Checkpoint *cp, const std::string §ion); 3509983Sstever@gmail.com 3519983Sstever@gmail.com //! This function is required to support restoring from checkpoints 3529983Sstever@gmail.com //! when running with multiple queues. Since we still have not thrashed 3539983Sstever@gmail.com //! out all the details on checkpointing, this function is most likely 3549983Sstever@gmail.com //! to be revisited in future. 3559983Sstever@gmail.com virtual void unserialize(Checkpoint *cp, const std::string §ion, 3569983Sstever@gmail.com EventQueue *eventq); 3575605Snate@binkert.org#endif 358571SN/A}; 359571SN/A 3607005Snate@binkert.org#ifndef SWIG 3617005Snate@binkert.orginline bool 3627005Snate@binkert.orgoperator<(const Event &l, const Event &r) 3637005Snate@binkert.org{ 3647005Snate@binkert.org return l.when() < r.when() || 3657005Snate@binkert.org (l.when() == r.when() && l.priority() < r.priority()); 3667005Snate@binkert.org} 3677005Snate@binkert.org 3687005Snate@binkert.orginline bool 3697005Snate@binkert.orgoperator>(const Event &l, const Event &r) 3707005Snate@binkert.org{ 3717005Snate@binkert.org return l.when() > r.when() || 3727005Snate@binkert.org (l.when() == r.when() && l.priority() > r.priority()); 3737005Snate@binkert.org} 3747005Snate@binkert.org 3757005Snate@binkert.orginline bool 3767005Snate@binkert.orgoperator<=(const Event &l, const Event &r) 3777005Snate@binkert.org{ 3787005Snate@binkert.org return l.when() < r.when() || 3797005Snate@binkert.org (l.when() == r.when() && l.priority() <= r.priority()); 3807005Snate@binkert.org} 3817005Snate@binkert.orginline bool 3827005Snate@binkert.orgoperator>=(const Event &l, const Event &r) 3837005Snate@binkert.org{ 3847005Snate@binkert.org return l.when() > r.when() || 3857005Snate@binkert.org (l.when() == r.when() && l.priority() >= r.priority()); 3867005Snate@binkert.org} 3877005Snate@binkert.org 3887005Snate@binkert.orginline bool 3897005Snate@binkert.orgoperator==(const Event &l, const Event &r) 3907005Snate@binkert.org{ 3917005Snate@binkert.org return l.when() == r.when() && l.priority() == r.priority(); 3927005Snate@binkert.org} 3937005Snate@binkert.org 3947005Snate@binkert.orginline bool 3957005Snate@binkert.orgoperator!=(const Event &l, const Event &r) 3967005Snate@binkert.org{ 3977005Snate@binkert.org return l.when() != r.when() || l.priority() != r.priority(); 3987005Snate@binkert.org} 3997005Snate@binkert.org#endif 4007005Snate@binkert.org 40110153Sandreas@sandberg.pp.se/** 4022SN/A * Queue of events sorted in time order 40310153Sandreas@sandberg.pp.se * 40410153Sandreas@sandberg.pp.se * Events are scheduled (inserted into the event queue) using the 40510153Sandreas@sandberg.pp.se * schedule() method. This method either inserts a <i>synchronous</i> 40610153Sandreas@sandberg.pp.se * or <i>asynchronous</i> event. 40710153Sandreas@sandberg.pp.se * 40810153Sandreas@sandberg.pp.se * Synchronous events are scheduled using schedule() method with the 40910153Sandreas@sandberg.pp.se * argument 'global' set to false (default). This should only be done 41010153Sandreas@sandberg.pp.se * from a thread holding the event queue lock 41110153Sandreas@sandberg.pp.se * (EventQueue::service_mutex). The lock is always held when an event 41210153Sandreas@sandberg.pp.se * handler is called, it can therefore always insert events into its 41310153Sandreas@sandberg.pp.se * own event queue unless it voluntarily releases the lock. 41410153Sandreas@sandberg.pp.se * 41510153Sandreas@sandberg.pp.se * Events can be scheduled across thread (and event queue borders) by 41610153Sandreas@sandberg.pp.se * either scheduling asynchronous events or taking the target event 41710153Sandreas@sandberg.pp.se * queue's lock. However, the lock should <i>never</i> be taken 41810153Sandreas@sandberg.pp.se * directly since this is likely to cause deadlocks. Instead, code 41910153Sandreas@sandberg.pp.se * that needs to schedule events in other event queues should 42010153Sandreas@sandberg.pp.se * temporarily release its own queue and lock the new queue. This 42110153Sandreas@sandberg.pp.se * prevents deadlocks since a single thread never owns more than one 42210153Sandreas@sandberg.pp.se * event queue lock. This functionality is provided by the 42310153Sandreas@sandberg.pp.se * ScopedMigration helper class. Note that temporarily migrating 42410153Sandreas@sandberg.pp.se * between event queues can make the simulation non-deterministic, it 42510153Sandreas@sandberg.pp.se * should therefore be limited to cases where that can be tolerated 42610153Sandreas@sandberg.pp.se * (e.g., handling asynchronous IO or fast-forwarding in KVM). 42710153Sandreas@sandberg.pp.se * 42810153Sandreas@sandberg.pp.se * Asynchronous events can also be scheduled using the normal 42910153Sandreas@sandberg.pp.se * schedule() method with the 'global' parameter set to true. Unlike 43010153Sandreas@sandberg.pp.se * the previous queue migration strategy, this strategy is fully 43110153Sandreas@sandberg.pp.se * deterministic. This causes the event to be inserted in a separate 43210153Sandreas@sandberg.pp.se * queue of asynchronous events (async_queue), which is merged main 43310153Sandreas@sandberg.pp.se * event queue at the end of each simulation quantum (by calling the 43410153Sandreas@sandberg.pp.se * handleAsyncInsertions() method). Note that this implies that such 43510153Sandreas@sandberg.pp.se * events must happen at least one simulation quantum into the future, 43610153Sandreas@sandberg.pp.se * otherwise they risk being scheduled in the past by 43710153Sandreas@sandberg.pp.se * handleAsyncInsertions(). 4382SN/A */ 439395SN/Aclass EventQueue : public Serializable 4402SN/A{ 4415605Snate@binkert.org private: 442265SN/A std::string objName; 4432SN/A Event *head; 4449356Snilay@cs.wisc.edu Tick _curTick; 4452SN/A 4469983Sstever@gmail.com //! Mutex to protect async queue. 4479983Sstever@gmail.com std::mutex *async_queue_mutex; 4489983Sstever@gmail.com 4499983Sstever@gmail.com //! List of events added by other threads to this event queue. 4509983Sstever@gmail.com std::list<Event*> async_queue; 4519983Sstever@gmail.com 45210153Sandreas@sandberg.pp.se /** 45310153Sandreas@sandberg.pp.se * Lock protecting event handling. 45410153Sandreas@sandberg.pp.se * 45510153Sandreas@sandberg.pp.se * This lock is always taken when servicing events. It is assumed 45610153Sandreas@sandberg.pp.se * that the thread scheduling new events (not asynchronous events 45710153Sandreas@sandberg.pp.se * though) have taken this lock. This is normally done by 45810153Sandreas@sandberg.pp.se * serviceOne() since new events are typically scheduled as a 45910153Sandreas@sandberg.pp.se * response to an earlier event. 46010153Sandreas@sandberg.pp.se * 46110153Sandreas@sandberg.pp.se * This lock is intended to be used to temporarily steal an event 46210153Sandreas@sandberg.pp.se * queue to support inter-thread communication when some 46310153Sandreas@sandberg.pp.se * deterministic timing can be sacrificed for speed. For example, 46410153Sandreas@sandberg.pp.se * the KVM CPU can use this support to access devices running in a 46510153Sandreas@sandberg.pp.se * different thread. 46610153Sandreas@sandberg.pp.se * 46710153Sandreas@sandberg.pp.se * @see EventQueue::ScopedMigration. 46810153Sandreas@sandberg.pp.se * @see EventQueue::ScopedRelease 46910153Sandreas@sandberg.pp.se * @see EventQueue::lock() 47010153Sandreas@sandberg.pp.se * @see EventQueue::unlock() 47110153Sandreas@sandberg.pp.se */ 47210153Sandreas@sandberg.pp.se std::mutex service_mutex; 47310153Sandreas@sandberg.pp.se 4749983Sstever@gmail.com //! Insert / remove event from the queue. Should only be called 4759983Sstever@gmail.com //! by thread operating this queue. 4762SN/A void insert(Event *event); 4772SN/A void remove(Event *event); 4782SN/A 4799983Sstever@gmail.com //! Function for adding events to the async queue. The added events 4809983Sstever@gmail.com //! are added to main event queue later. Threads, other than the 4819983Sstever@gmail.com //! owning thread, should call this function instead of insert(). 4829983Sstever@gmail.com void asyncInsert(Event *event); 4839983Sstever@gmail.com 4847063Snate@binkert.org EventQueue(const EventQueue &); 4857063Snate@binkert.org 4862SN/A public: 48710153Sandreas@sandberg.pp.se#ifndef SWIG 48810153Sandreas@sandberg.pp.se /** 48910153Sandreas@sandberg.pp.se * Temporarily migrate execution to a different event queue. 49010153Sandreas@sandberg.pp.se * 49110153Sandreas@sandberg.pp.se * An instance of this class temporarily migrates execution to a 49210153Sandreas@sandberg.pp.se * different event queue by releasing the current queue, locking 49310153Sandreas@sandberg.pp.se * the new queue, and updating curEventQueue(). This can, for 49410153Sandreas@sandberg.pp.se * example, be useful when performing IO across thread event 49510153Sandreas@sandberg.pp.se * queues when timing is not crucial (e.g., during fast 49610153Sandreas@sandberg.pp.se * forwarding). 49710153Sandreas@sandberg.pp.se */ 49810153Sandreas@sandberg.pp.se class ScopedMigration 49910153Sandreas@sandberg.pp.se { 50010153Sandreas@sandberg.pp.se public: 50110153Sandreas@sandberg.pp.se ScopedMigration(EventQueue *_new_eq) 50210153Sandreas@sandberg.pp.se : new_eq(*_new_eq), old_eq(*curEventQueue()) 50310153Sandreas@sandberg.pp.se { 50410153Sandreas@sandberg.pp.se old_eq.unlock(); 50510153Sandreas@sandberg.pp.se new_eq.lock(); 50610153Sandreas@sandberg.pp.se curEventQueue(&new_eq); 50710153Sandreas@sandberg.pp.se } 50810153Sandreas@sandberg.pp.se 50910153Sandreas@sandberg.pp.se ~ScopedMigration() 51010153Sandreas@sandberg.pp.se { 51110153Sandreas@sandberg.pp.se new_eq.unlock(); 51210153Sandreas@sandberg.pp.se old_eq.lock(); 51310153Sandreas@sandberg.pp.se curEventQueue(&old_eq); 51410153Sandreas@sandberg.pp.se } 51510153Sandreas@sandberg.pp.se 51610153Sandreas@sandberg.pp.se private: 51710153Sandreas@sandberg.pp.se EventQueue &new_eq; 51810153Sandreas@sandberg.pp.se EventQueue &old_eq; 51910153Sandreas@sandberg.pp.se }; 52010153Sandreas@sandberg.pp.se 52110153Sandreas@sandberg.pp.se /** 52210153Sandreas@sandberg.pp.se * Temporarily release the event queue service lock. 52310153Sandreas@sandberg.pp.se * 52410153Sandreas@sandberg.pp.se * There are cases where it is desirable to temporarily release 52510153Sandreas@sandberg.pp.se * the event queue lock to prevent deadlocks. For example, when 52610153Sandreas@sandberg.pp.se * waiting on the global barrier, we need to release the lock to 52710153Sandreas@sandberg.pp.se * prevent deadlocks from happening when another thread tries to 52810153Sandreas@sandberg.pp.se * temporarily take over the event queue waiting on the barrier. 52910153Sandreas@sandberg.pp.se */ 53010153Sandreas@sandberg.pp.se class ScopedRelease 53110153Sandreas@sandberg.pp.se { 53210153Sandreas@sandberg.pp.se public: 53310153Sandreas@sandberg.pp.se ScopedRelease(EventQueue *_eq) 53410153Sandreas@sandberg.pp.se : eq(*_eq) 53510153Sandreas@sandberg.pp.se { 53610153Sandreas@sandberg.pp.se eq.unlock(); 53710153Sandreas@sandberg.pp.se } 53810153Sandreas@sandberg.pp.se 53910153Sandreas@sandberg.pp.se ~ScopedRelease() 54010153Sandreas@sandberg.pp.se { 54110153Sandreas@sandberg.pp.se eq.lock(); 54210153Sandreas@sandberg.pp.se } 54310153Sandreas@sandberg.pp.se 54410153Sandreas@sandberg.pp.se private: 54510153Sandreas@sandberg.pp.se EventQueue &eq; 54610153Sandreas@sandberg.pp.se }; 54710153Sandreas@sandberg.pp.se#endif 54810153Sandreas@sandberg.pp.se 5497063Snate@binkert.org EventQueue(const std::string &n); 5502SN/A 551512SN/A virtual const std::string name() const { return objName; } 5529983Sstever@gmail.com void name(const std::string &st) { objName = st; } 553265SN/A 5549983Sstever@gmail.com //! Schedule the given event on this queue. Safe to call from any 5559983Sstever@gmail.com //! thread. 5569983Sstever@gmail.com void schedule(Event *event, Tick when, bool global = false); 5579983Sstever@gmail.com 5589983Sstever@gmail.com //! Deschedule the specified event. Should be called only from the 5599983Sstever@gmail.com //! owning thread. 5605738Snate@binkert.org void deschedule(Event *event); 5619983Sstever@gmail.com 5629983Sstever@gmail.com //! Reschedule the specified event. Should be called only from 5639983Sstever@gmail.com //! the owning thread. 5645738Snate@binkert.org void reschedule(Event *event, Tick when, bool always = false); 5652SN/A 5665501Snate@binkert.org Tick nextTick() const { return head->when(); } 5679356Snilay@cs.wisc.edu void setCurTick(Tick newVal) { _curTick = newVal; } 5689356Snilay@cs.wisc.edu Tick getCurTick() { return _curTick; } 5699356Snilay@cs.wisc.edu 5702667Sstever@eecs.umich.edu Event *serviceOne(); 5712SN/A 5722SN/A // process all events up to the given timestamp. we inline a 5732SN/A // quick test to see if there are any events to process; if so, 5742SN/A // call the internal out-of-line version to process them all. 5755501Snate@binkert.org void 5765501Snate@binkert.org serviceEvents(Tick when) 5775501Snate@binkert.org { 5782SN/A while (!empty()) { 5792SN/A if (nextTick() > when) 5802SN/A break; 5812SN/A 5821634SN/A /** 5831634SN/A * @todo this assert is a good bug catcher. I need to 5841634SN/A * make it true again. 5851634SN/A */ 5861634SN/A //assert(head->when() >= when && "event scheduled in the past"); 5872SN/A serviceOne(); 5882SN/A } 5899356Snilay@cs.wisc.edu 5909356Snilay@cs.wisc.edu setCurTick(when); 5912SN/A } 5922SN/A 5932SN/A // return true if no events are queued 5945501Snate@binkert.org bool empty() const { return head == NULL; } 5952SN/A 5965501Snate@binkert.org void dump() const; 5972SN/A 5985502Snate@binkert.org bool debugVerify() const; 5995502Snate@binkert.org 6009983Sstever@gmail.com //! Function for moving events from the async_queue to the main queue. 6019983Sstever@gmail.com void handleAsyncInsertions(); 6029983Sstever@gmail.com 6038648Snilay@cs.wisc.edu /** 6048648Snilay@cs.wisc.edu * function for replacing the head of the event queue, so that a 6058648Snilay@cs.wisc.edu * different set of events can run without disturbing events that have 6068648Snilay@cs.wisc.edu * already been scheduled. Already scheduled events can be processed 6078648Snilay@cs.wisc.edu * by replacing the original head back. 6088648Snilay@cs.wisc.edu * USING THIS FUNCTION CAN BE DANGEROUS TO THE HEALTH OF THE SIMULATOR. 6098648Snilay@cs.wisc.edu * NOT RECOMMENDED FOR USE. 6108648Snilay@cs.wisc.edu */ 6118648Snilay@cs.wisc.edu Event* replaceHead(Event* s); 6128648Snilay@cs.wisc.edu 61310153Sandreas@sandberg.pp.se /**@{*/ 61410153Sandreas@sandberg.pp.se /** 61510153Sandreas@sandberg.pp.se * Provide an interface for locking/unlocking the event queue. 61610153Sandreas@sandberg.pp.se * 61710153Sandreas@sandberg.pp.se * @warn Do NOT use these methods directly unless you really know 61810153Sandreas@sandberg.pp.se * what you are doing. Incorrect use can easily lead to simulator 61910153Sandreas@sandberg.pp.se * deadlocks. 62010153Sandreas@sandberg.pp.se * 62110153Sandreas@sandberg.pp.se * @see EventQueue::ScopedMigration. 62210153Sandreas@sandberg.pp.se * @see EventQueue::ScopedRelease 62310153Sandreas@sandberg.pp.se * @see EventQueue 62410153Sandreas@sandberg.pp.se */ 62510153Sandreas@sandberg.pp.se void lock() { service_mutex.lock(); } 62610153Sandreas@sandberg.pp.se void unlock() { service_mutex.unlock(); } 62710153Sandreas@sandberg.pp.se /**@}*/ 62810153Sandreas@sandberg.pp.se 6295605Snate@binkert.org#ifndef SWIG 630217SN/A virtual void serialize(std::ostream &os); 631237SN/A virtual void unserialize(Checkpoint *cp, const std::string §ion); 6325605Snate@binkert.org#endif 6332SN/A}; 6342SN/A 6359554Sandreas.hansson@arm.comvoid dumpMainQueue(); 6369554Sandreas.hansson@arm.com 6375605Snate@binkert.org#ifndef SWIG 6385605Snate@binkert.orgclass EventManager 6395605Snate@binkert.org{ 6405605Snate@binkert.org protected: 6415605Snate@binkert.org /** A pointer to this object's event queue */ 6425605Snate@binkert.org EventQueue *eventq; 6432SN/A 6445605Snate@binkert.org public: 6459099Sandreas.hansson@arm.com EventManager(EventManager &em) : eventq(em.eventq) {} 6469159Sandreas.hansson@arm.com EventManager(EventManager *em) : eventq(em->eventq) {} 6475605Snate@binkert.org EventManager(EventQueue *eq) : eventq(eq) {} 6482SN/A 6495605Snate@binkert.org EventQueue * 6509099Sandreas.hansson@arm.com eventQueue() const 6517060Snate@binkert.org { 6527060Snate@binkert.org return eventq; 6537060Snate@binkert.org } 6547060Snate@binkert.org 6555605Snate@binkert.org void 6565605Snate@binkert.org schedule(Event &event, Tick when) 6575605Snate@binkert.org { 6585605Snate@binkert.org eventq->schedule(&event, when); 6595605Snate@binkert.org } 6605605Snate@binkert.org 6615605Snate@binkert.org void 6625605Snate@binkert.org deschedule(Event &event) 6635605Snate@binkert.org { 6645605Snate@binkert.org eventq->deschedule(&event); 6655605Snate@binkert.org } 6665605Snate@binkert.org 6675605Snate@binkert.org void 6685605Snate@binkert.org reschedule(Event &event, Tick when, bool always = false) 6695605Snate@binkert.org { 6705605Snate@binkert.org eventq->reschedule(&event, when, always); 6715605Snate@binkert.org } 6725605Snate@binkert.org 6735605Snate@binkert.org void 6745605Snate@binkert.org schedule(Event *event, Tick when) 6755605Snate@binkert.org { 6765605Snate@binkert.org eventq->schedule(event, when); 6775605Snate@binkert.org } 6785605Snate@binkert.org 6795605Snate@binkert.org void 6805605Snate@binkert.org deschedule(Event *event) 6815605Snate@binkert.org { 6825605Snate@binkert.org eventq->deschedule(event); 6835605Snate@binkert.org } 6845605Snate@binkert.org 6855605Snate@binkert.org void 6865605Snate@binkert.org reschedule(Event *event, Tick when, bool always = false) 6875605Snate@binkert.org { 6885605Snate@binkert.org eventq->reschedule(event, when, always); 6895605Snate@binkert.org } 6909356Snilay@cs.wisc.edu 6919356Snilay@cs.wisc.edu void setCurTick(Tick newVal) { eventq->setCurTick(newVal); } 6925605Snate@binkert.org}; 6935605Snate@binkert.org 6947005Snate@binkert.orgtemplate <class T, void (T::* F)()> 6957005Snate@binkert.orgvoid 6967005Snate@binkert.orgDelayFunction(EventQueue *eventq, Tick when, T *object) 6975502Snate@binkert.org{ 6987005Snate@binkert.org class DelayEvent : public Event 6997005Snate@binkert.org { 7007005Snate@binkert.org private: 7017005Snate@binkert.org T *object; 7027005Snate@binkert.org 7037005Snate@binkert.org public: 7047005Snate@binkert.org DelayEvent(T *o) 7058581Ssteve.reinhardt@amd.com : Event(Default_Pri, AutoDelete), object(o) 7068581Ssteve.reinhardt@amd.com { } 7077005Snate@binkert.org void process() { (object->*F)(); } 7087005Snate@binkert.org const char *description() const { return "delay"; } 7097005Snate@binkert.org }; 7107005Snate@binkert.org 7117005Snate@binkert.org eventq->schedule(new DelayEvent(object), when); 7125502Snate@binkert.org} 7135502Snate@binkert.org 7147005Snate@binkert.orgtemplate <class T, void (T::* F)()> 7157005Snate@binkert.orgclass EventWrapper : public Event 7165502Snate@binkert.org{ 7177005Snate@binkert.org private: 7187005Snate@binkert.org T *object; 7195502Snate@binkert.org 7207005Snate@binkert.org public: 7217005Snate@binkert.org EventWrapper(T *obj, bool del = false, Priority p = Default_Pri) 7227005Snate@binkert.org : Event(p), object(obj) 7237005Snate@binkert.org { 7247005Snate@binkert.org if (del) 7257005Snate@binkert.org setFlags(AutoDelete); 7267005Snate@binkert.org } 7275502Snate@binkert.org 7287066Snate@binkert.org EventWrapper(T &obj, bool del = false, Priority p = Default_Pri) 7297066Snate@binkert.org : Event(p), object(&obj) 7307066Snate@binkert.org { 7317066Snate@binkert.org if (del) 7327066Snate@binkert.org setFlags(AutoDelete); 7337066Snate@binkert.org } 7347066Snate@binkert.org 7357005Snate@binkert.org void process() { (object->*F)(); } 7365502Snate@binkert.org 7377005Snate@binkert.org const std::string 7387005Snate@binkert.org name() const 7397005Snate@binkert.org { 7407005Snate@binkert.org return object->name() + ".wrapped_event"; 7417005Snate@binkert.org } 7427005Snate@binkert.org 7437005Snate@binkert.org const char *description() const { return "EventWrapped"; } 7447005Snate@binkert.org}; 7455605Snate@binkert.org#endif 7462SN/A 7471354SN/A#endif // __SIM_EVENTQ_HH__ 748