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 SimExitEvent : public Event
  40 {
  41   private:
  42     // string explaining why we're terminating
  43     std::string cause;
  44     int code;
  45
  46   public:
  47     SimExitEvent(const std::string &_cause, int c = 0)
  48         : Event(&mainEventQueue, Sim_Exit_Pri), cause(_cause),
  49           code(c)
  50         { schedule(curTick); }
  51
  52     SimExitEvent(Tick _when, const std::string &_cause, int c = 0)
  53         : Event(&mainEventQueue, Sim_Exit_Pri), cause(_cause),
  54           code(c)
  55         { schedule(_when); }
  56
  57     SimExitEvent(EventQueue *q, const std::string &_cause, int c = 0)
  58         : Event(q, Sim_Exit_Pri), cause(_cause), code(c)
  59         { schedule(curTick); }
  60
  61     SimExitEvent(EventQueue *q, Tick _when, const std::string &_cause,
  62                  int c = 0)
  63         : Event(q, Sim_Exit_Pri), cause(_cause), code(c)
  64         { schedule(_when); }
  65
  66     void process();     // process event
  67
  68     virtual const char *description();
  69 };
  70
  71 //
  72 // Event class to terminate simulation after 'n' related events have
  73 // occurred using a shared counter: used to terminate when *all*
  74 // threads have reached a particular instruction count
  75 //
  76 class CountedExitEvent : public Event
  77 {
  78   private:
  79     std::string cause;  // string explaining why we're terminating
  80     int &downCounter;   // decrement & terminate if zero
  81
  82   public:
  83     CountedExitEvent(EventQueue *q, const std::string &_cause,
  84                      Tick _when, int &_downCounter);
  85
  86     void process();     // process event
  87
  88     virtual const char *description();
  89 };
  90
  91 //
  92 // Event to check swap usage
  93 //
  94 class CheckSwapEvent : public Event
  95 {
  96   private:
  97     int interval;
  98
  99   public:
 100     CheckSwapEvent(EventQueue *q, int ival)
 101         : Event(q), interval(ival)
 102     { schedule(curTick + interval); }
 103
 104     void process();     // process event
 105
 106     virtual const char *description();
 107 };
 108
 109 //
 110 // Progress event: print out cycle every so often so we know we're
 111 // making forward progress.
 112 //
 113 class ProgressEvent : public Event
 114 {
 115   protected:
 116     Tick interval;
 117
 118   public:
 119     ProgressEvent(EventQueue *q, Tick ival)
 120         : Event(q), interval(ival)
 121     { schedule(curTick + interval); }
 122
 123     void process();     // process event
 124
 125     virtual const char *description();
 126 };
 127
 128 #endif  // __SIM_SIM_EVENTS_HH__