2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
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.
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.
28 * Authors: Nathan Binkert
31 #ifndef __SIM_SIM_EVENTS_HH__
32 #define __SIM_SIM_EVENTS_HH__
34 #include "sim/eventq.hh"
37 // Event to terminate simulation at a particular cycle/instruction
39 class SimLoopExitEvent : public Event
42 // string explaining why we're terminating
47 // Default constructor. Only really used for derived classes.
49 : Event(&mainEventQueue, Sim_Exit_Pri)
52 SimLoopExitEvent(Tick _when, const std::string &_cause, int c = 0)
53 : Event(&mainEventQueue, Sim_Exit_Pri), cause(_cause),
55 { setFlags(IsExitEvent); schedule(_when); }
57 SimLoopExitEvent(EventQueue *q,
58 Tick _when, const std::string &_cause, int c = 0)
59 : Event(q, Sim_Exit_Pri), cause(_cause), code(c)
60 { setFlags(IsExitEvent); schedule(_when); }
62 std::string getCause() { return cause; }
63 int getCode() { return code; }
65 void process(); // process event
67 virtual const char *description();
70 class CountedQuiesceEvent : public SimLoopExitEvent
73 // Count down to quiescing
81 void setCount(int _count) { count = _count; }
83 int getCount() { return count; }
87 // Event class to terminate simulation after 'n' related events have
88 // occurred using a shared counter: used to terminate when *all*
89 // threads have reached a particular instruction count
91 class CountedExitEvent : public Event
94 std::string cause; // string explaining why we're terminating
95 int &downCounter; // decrement & terminate if zero
98 CountedExitEvent(EventQueue *q, const std::string &_cause,
99 Tick _when, int &_downCounter);
101 void process(); // process event
103 virtual const char *description();
107 // Event to check swap usage
109 class CheckSwapEvent : public Event
115 CheckSwapEvent(EventQueue *q, int ival)
116 : Event(q), interval(ival)
117 { schedule(curTick + interval); }
119 void process(); // process event
121 virtual const char *description();
125 // Progress event: print out cycle every so often so we know we're
126 // making forward progress.
128 class ProgressEvent : public Event
134 ProgressEvent(EventQueue *q, Tick ival)
135 : Event(q), interval(ival)
136 { schedule(curTick + interval); }
138 void process(); // process event
140 virtual const char *description();
143 #endif // __SIM_SIM_EVENTS_HH__