sim_events.hh revision 2632:1bb2f91485ea 
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
29#ifndef __SIM_SIM_EVENTS_HH__
30#define __SIM_SIM_EVENTS_HH__
31
32#include "sim/eventq.hh"
33
34//
35// Event to terminate simulation at a particular cycle/instruction
36//
37class 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, Sim_Exit_Pri), cause(_cause),
47          code(c)
48        { schedule(curTick); }
49
50    SimExitEvent(Tick _when, const std::string &_cause, int c = 0)
51        : Event(&mainEventQueue, Sim_Exit_Pri), cause(_cause),
52          code(c)
53        { schedule(_when); }
54
55    SimExitEvent(EventQueue *q, const std::string &_cause, int c = 0)
56        : Event(q, Sim_Exit_Pri), cause(_cause), code(c)
57        { schedule(curTick); }
58
59    SimExitEvent(EventQueue *q, Tick _when, const std::string &_cause,
60                 int c = 0)
61        : Event(q, Sim_Exit_Pri), cause(_cause), code(c)
62        { schedule(_when); }
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//
74class 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 check swap usage
91//
92class CheckSwapEvent : public Event
93{
94  private:
95    int interval;
96
97  public:
98    CheckSwapEvent(EventQueue *q, int ival)
99        : Event(q), interval(ival)
100    { schedule(curTick + interval); }
101
102    void process();	// process event
103
104    virtual const char *description();
105};
106
107//
108// Progress event: print out cycle every so often so we know we're
109// making forward progress.
110//
111class ProgressEvent : public Event
112{
113  protected:
114    Tick interval;
115
116  public:
117    ProgressEvent(EventQueue *q, Tick ival)
118        : Event(q), interval(ival)
119    { schedule(curTick + interval); }
120
121    void process();	// process event
122
123    virtual const char *description();
124};
125
126#endif  // __SIM_SIM_EVENTS_HH__
127