sim/sim_events.hh

   1 /*
   2  * Copyright (c) 2003 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 __SIM_EVENTS_HH__
  30 #define __SIM_EVENTS_HH__
  31
  32 #include "sim/eventq.hh"
  33
  34 //
  35 // Event to terminate simulation at a particular cycle/instruction
  36 //
  37 class SimExitEvent : public Event
  38 {
  39   private:
  40     // string explaining why we're terminating
  41     std::string cause;
  42     int code;
  43
  44   public:
  45     SimExitEvent(const std::string &_cause, int c = 0)
  46         : Event(&mainEventQueue), cause(_cause),
  47           code(c)
  48         { schedule(curTick, 1000); }
  49
  50     SimExitEvent(Tick _when, const std::string &_cause, int c = 0)
  51         : Event(&mainEventQueue), cause(_cause),
  52           code(c)
  53         { schedule(_when, 1000); }
  54
  55     SimExitEvent(EventQueue *q, const std::string &_cause, int c = 0)
  56         : Event(q), cause(_cause), code(c)
  57         { schedule(curTick, 1000); }
  58
  59     SimExitEvent(EventQueue *q, Tick _when, const std::string &_cause,
  60                  int c = 0)
  61         : Event(q), cause(_cause), code(c)
  62         { schedule(_when, 1000); }
  63
  64     void process();     // process event
  65
  66     virtual const char *description();
  67 };
  68
  69 //
  70 // Event class to terminate simulation after 'n' related events have
  71 // occurred using a shared counter: used to terminate when *all*
  72 // threads have reached a particular instruction count
  73 //
  74 class CountedExitEvent : public Event
  75 {
  76   private:
  77     std::string cause;  // string explaining why we're terminating
  78     int &downCounter;   // decrement & terminate if zero
  79
  80   public:
  81     CountedExitEvent(EventQueue *q, const std::string &_cause,
  82                      Tick _when, int &_downCounter);
  83
  84     void process();     // process event
  85
  86     virtual const char *description();
  87 };
  88
  89 //
  90 // Event to cause a statistics dump
  91 //
  92 class DumpStatsEvent : public Event
  93 {
  94   public:
  95     DumpStatsEvent()
  96         : Event(&mainEventQueue)
  97         { setFlags(AutoDelete); schedule(curTick, 999); }
  98
  99     DumpStatsEvent(EventQueue *q)
 100         : Event(q)
 101         { setFlags(AutoDelete); schedule(curTick, 999); }
 102
 103     DumpStatsEvent(Tick when)
 104         : Event(&mainEventQueue)
 105         { setFlags(AutoDelete); schedule(when, 999); }
 106
 107     DumpStatsEvent(EventQueue *q, Tick when)
 108         : Event(q)
 109         { setFlags(AutoDelete); schedule(when, 999); }
 110
 111     void process();
 112
 113     virtual const char *description();
 114 };
 115
 116 class CheckSwapEvent : public Event
 117 {
 118   private:
 119     int interval;
 120
 121   public:
 122     CheckSwapEvent(EventQueue *q, int ival)
 123         : Event(q), interval(ival)
 124         { schedule(interval); }
 125
 126     void process();     // process event
 127
 128     virtual const char *description();
 129 };
 130
 131 #endif  // __SIM_EVENTS_HH__