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
  29 #ifndef __CPU_CPUEVENT_HH__
  30 #define __CPU_CPUEVENT_HH__
  31
  32 #include <vector>
  33
  34 #include "sim/eventq.hh"
  35
  36 class ThreadContext;
  37
  38 /**
  39  * This class creates a global list of events that need a pointer to a
  40  * thread context. When a switchover takes place the events can be
  41  * migrated to the new thread context, otherwise you could have a wake
  42  * timer interrupt go off on a switched out cpu or other unfortunate
  43  * events. This object MUST be dynamically allocated to avoid it being
  44  * deleted after a cpu switch happens.
  45  */
  46 class CpuEvent : public Event
  47 {
  48   protected:
  49     /** type of global list of cpu events. */
  50     typedef std::vector<CpuEvent *> CpuEventList;
  51
  52     /** Static list of cpu events that is searched every time a cpu switch
  53      * happens. */
  54     static CpuEventList cpuEventList;
  55
  56     /** The thread context that is switched to the new cpus. */
  57     ThreadContext *tc;
  58
  59   public:
  60     CpuEvent(ThreadContext *_tc, Priority p = Default_Pri)
  61         : Event(p), tc(_tc)
  62     { cpuEventList.push_back(this); }
  63
  64     /** delete the cpu event from the global list. */
  65     ~CpuEvent();
  66
  67     /** Update all events switching old tc to new tc.
  68      * @param oldTc the old thread context we are switching from
  69      * @param newTc the new thread context we are switching to.
  70      */
  71     static void replaceThreadContext(ThreadContext *oldTc,
  72                                      ThreadContext *newTc);
  73     ThreadContext* getTC() { return tc; }
  74 };
  75
  76 template <class T, void (T::* F)(ThreadContext *tc)>
  77 class CpuEventWrapper : public CpuEvent
  78 {
  79   private:
  80     T *object;
  81
  82   public:
  83     CpuEventWrapper(T *obj, ThreadContext *_tc, Priority p = Default_Pri)
  84         : CpuEvent(_tc, p), object(obj)
  85     { }
  86     void process() { (object->*F)(tc); }
  87 };
  88
  89 #endif // __CPU_CPUEVENT_HH__
  90