sim_events.hh revision 9952 
1/*
2 * Copyright (c) 2013 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2002-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Nathan Binkert
41 */
42
43#ifndef __SIM_SIM_EVENTS_HH__
44#define __SIM_SIM_EVENTS_HH__
45
46#include "sim/eventq.hh"
47#include "sim/serialize.hh"
48
49//
50// Event to terminate simulation at a particular cycle/instruction
51//
52class SimLoopExitEvent : public Event
53{
54  protected:
55    // string explaining why we're terminating
56    std::string cause;
57    int code;
58    Tick repeat;
59
60  public:
61    // non-scheduling version for createForUnserialize()
62    SimLoopExitEvent();
63    SimLoopExitEvent(const std::string &_cause, int c, Tick repeat = 0,
64                     bool serialize = false);
65
66    std::string getCause() { return cause; }
67    int getCode() { return code; }
68
69    void process();     // process event
70
71    virtual const char *description() const;
72
73    virtual void serialize(std::ostream &os);
74    virtual void unserialize(Checkpoint *cp, const std::string &section);
75    static Serializable *createForUnserialize(Checkpoint *cp,
76                                              const std::string &section);
77};
78
79class CountedDrainEvent : public Event
80{
81  private:
82    // Count of how many objects have not yet drained
83    int count;
84
85  public:
86    CountedDrainEvent();
87
88    void process();
89
90    void setCount(int _count) { count = _count; }
91
92    int getCount() { return count; }
93};
94
95//
96// Event class to terminate simulation after 'n' related events have
97// occurred using a shared counter: used to terminate when *all*
98// threads have reached a particular instruction count
99//
100class CountedExitEvent : public Event
101{
102  private:
103    std::string cause;  // string explaining why we're terminating
104    int &downCounter;   // decrement & terminate if zero
105
106  public:
107    CountedExitEvent(const std::string &_cause, int &_downCounter);
108
109    void process();     // process event
110
111    virtual const char *description() const;
112};
113
114
115#endif  // __SIM_SIM_EVENTS_HH__
116