src/sim/sim_events.hh

   1 /*
   2  * Copyright (c) 2002-2005 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: Nathan Binkert
  29  */
  30
  31 #ifndef __SIM_SIM_EVENTS_HH__
  32 #define __SIM_SIM_EVENTS_HH__
  33
  34 #include "sim/eventq.hh"
  35
  36 //
  37 // Event to terminate simulation at a particular cycle/instruction
  38 //
  39 class SimLoopExitEvent : public Event
  40 {
  41   protected:
  42     // string explaining why we're terminating
  43     std::string cause;
  44     int code;
  45     Tick repeat;
  46
  47   public:
  48     SimLoopExitEvent(const std::string &_cause, int c, Tick repeat = 0);
  49
  50     std::string getCause() { return cause; }
  51     int getCode() { return code; }
  52
  53     void process();     // process event
  54
  55     virtual const char *description() const;
  56 };
  57
  58 class CountedDrainEvent : public SimLoopExitEvent
  59 {
  60   private:
  61     // Count of how many objects have not yet drained
  62     int count;
  63
  64   public:
  65     CountedDrainEvent();
  66
  67     void process();
  68
  69     void setCount(int _count) { count = _count; }
  70
  71     int getCount() { return count; }
  72 };
  73
  74 //
  75 // Event class to terminate simulation after 'n' related events have
  76 // occurred using a shared counter: used to terminate when *all*
  77 // threads have reached a particular instruction count
  78 //
  79 class CountedExitEvent : public Event
  80 {
  81   private:
  82     std::string cause;  // string explaining why we're terminating
  83     int &downCounter;   // decrement & terminate if zero
  84
  85   public:
  86     CountedExitEvent(const std::string &_cause, int &_downCounter);
  87
  88     void process();     // process event
  89
  90     virtual const char *description() const;
  91 };
  92
  93 //
  94 // Event to check swap usage
  95 //
  96 class CheckSwapEvent : public Event
  97 {
  98   private:
  99     int interval;
 100
 101   public:
 102     CheckSwapEvent(int ival);
 103     void process();     // process event
 104
 105     virtual const char *description() const;
 106 };
 107
 108 #endif  // __SIM_SIM_EVENTS_HH__