src/cpu/cpuevent.hh

   1 /*
   2  * Copyright (c) 2006 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Ali Saidi
  29  */
  30
  31 #ifndef __CPU_CPUEVENT_HH__
  32 #define __CPU_CPUEVENT_HH__
  33
  34 #include <vector>
  35 #include "sim/eventq.hh"
  36
  37 class ExecContext;
  38
  39 /** This class creates a global list of events than need a pointer to an
  40  * execution context. When a switchover takes place the events can be migrated
  41  * to the new execution context, otherwise you could have a wake timer interrupt
  42  * go off on a switched out cpu or other unfortunate events. This object MUST be
  43  * dynamically allocated to avoid it being deleted after a cpu switch happens.
  44  * */
  45 class CpuEvent : public Event
  46 {
  47   private:
  48     /** type of global list of cpu events. */
  49     typedef std::vector<CpuEvent *> CpuEventList;
  50
  51     /** Static list of cpu events that is searched every time a cpu switch
  52      * happens. */
  53     static CpuEventList cpuEventList;
  54
  55     /** The execution context that is switched to the new cpus. */
  56     ExecContext *xc;
  57
  58   public:
  59     CpuEvent(EventQueue *q, ExecContext *_xc, Priority p = Default_Pri)
  60         : Event(q, p), xc(_xc)
  61     { cpuEventList.push_back(this); }
  62
  63     /** delete the cpu event from the global list. */
  64     ~CpuEvent();
  65
  66     /** Update all events switching old xc to new xc.
  67      * @param oldXc the old exeuction context we are switching from
  68      * @param newXc the new execution context we are switching to.
  69      */
  70     static void replaceExecContext(ExecContext *oldXc, ExecContext *newXc);
  71 };
  72
  73 template <class T, void (T::* F)(ExecContext *xc)>
  74 class CpuEventWrapper : public CpuEvent
  75 {
  76   private:
  77     T *object;
  78
  79   public:
  80     CpuEventWrapper(T *obj, ExecContext *_xc, EventQueue *q = &mainEventQueue,
  81             Priority p = Default_Pri)
  82         : CpuEvent(q, _xc, p), object(obj)
  83     { }
  84     void process() { (object->*F)(xc); }
  85 };
  86
  87 #endif // __CPU_CPUEVENT_HH__
  88