sim_events.hh revision 3144 
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//
39class SimLoopExitEvent : public Event
40{
41  private:
42    // string explaining why we're terminating
43    std::string cause;
44    int code;
45    Tick repeat;
46
47  public:
48    // Default constructor.  Only really used for derived classes.
49    SimLoopExitEvent()
50        : Event(&mainEventQueue, Sim_Exit_Pri)
51    { }
52
53    SimLoopExitEvent(EventQueue *q,
54                     Tick _when, Tick _repeat, const std::string &_cause,
55                     int c = 0)
56        : Event(q, Sim_Exit_Pri), cause(_cause),
57          code(c), repeat(_repeat)
58    { setFlags(IsExitEvent); schedule(_when); }
59
60//     SimLoopExitEvent(EventQueue *q,
61// 		     Tick _when, const std::string &_cause,
62// 		     Tick _repeat = 0, int c = 0)
63// 	: Event(q, Sim_Exit_Pri), cause(_cause), code(c), repeat(_repeat)
64//     { setFlags(IsExitEvent); schedule(_when); }
65
66    std::string getCause() { return cause; }
67    int getCode() { return code; }
68
69    void process();	// process event
70
71    virtual const char *description();
72};
73
74class CountedDrainEvent : public SimLoopExitEvent
75{
76  private:
77    // Count of how many objects have not yet drained
78    int count;
79  public:
80    CountedDrainEvent()
81        : count(0)
82    { }
83    void process();
84
85    void setCount(int _count) { count = _count; }
86
87    int getCount() { return count; }
88};
89
90//
91// Event class to terminate simulation after 'n' related events have
92// occurred using a shared counter: used to terminate when *all*
93// threads have reached a particular instruction count
94//
95class CountedExitEvent : public Event
96{
97  private:
98    std::string cause;	// string explaining why we're terminating
99    int &downCounter;	// decrement & terminate if zero
100
101  public:
102    CountedExitEvent(EventQueue *q, const std::string &_cause,
103                     Tick _when, int &_downCounter);
104
105    void process();	// process event
106
107    virtual const char *description();
108};
109
110//
111// Event to check swap usage
112//
113class CheckSwapEvent : public Event
114{
115  private:
116    int interval;
117
118  public:
119    CheckSwapEvent(EventQueue *q, int 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//
129// Progress event: print out cycle every so often so we know we're
130// making forward progress.
131//
132class ProgressEvent : public Event
133{
134  protected:
135    Tick interval;
136
137  public:
138    ProgressEvent(EventQueue *q, Tick ival)
139        : Event(q), interval(ival)
140    { schedule(curTick + interval); }
141
142    void process();	// process event
143
144    virtual const char *description();
145};
146
147#endif  // __SIM_SIM_EVENTS_HH__
148