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