sim_events.hh revision 10756:f9c0692f73ec 
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 * Copyright (c) 2013 Advanced Micro Devices, Inc.
16 * Copyright (c) 2013 Mark D. Hill and David A. Wood
17 * All rights reserved.
18 *
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions are
21 * met: redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer;
23 * redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in the
25 * documentation and/or other materials provided with the distribution;
26 * neither the name of the copyright holders nor the names of its
27 * contributors may be used to endorse or promote products derived from
28 * this software without specific prior written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
31 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
32 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
33 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
34 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
36 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
37 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
38 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
39 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
40 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 *
42 * Authors: Nathan Binkert
43 */
44
45#ifndef __SIM_SIM_EVENTS_HH__
46#define __SIM_SIM_EVENTS_HH__
47
48#include "sim/global_event.hh"
49#include "sim/serialize.hh"
50
51//
52// Event to terminate simulation at a particular cycle/instruction
53//
54class GlobalSimLoopExitEvent : public GlobalEvent
55{
56  protected:
57    // string explaining why we're terminating
58    std::string cause;
59    int code;
60    Tick repeat;
61
62  public:
63    // non-scheduling version for createForUnserialize()
64    GlobalSimLoopExitEvent();
65    GlobalSimLoopExitEvent(Tick when, const std::string &_cause, int c,
66                           Tick repeat = 0, bool serialize = false);
67
68    const std::string getCause() const { return cause; }
69    const int getCode() const { return code; }
70
71    void process();     // process event
72
73    virtual const char *description() const;
74
75    virtual ~GlobalSimLoopExitEvent() {
76        // simulate()'s singleton GlobalSimLoopExitEvent is always scheduled
77        deschedule();
78    }
79};
80
81class LocalSimLoopExitEvent : public Event
82{
83  protected:
84    // string explaining why we're terminating
85    std::string cause;
86    int code;
87    Tick repeat;
88
89  public:
90    LocalSimLoopExitEvent();
91    LocalSimLoopExitEvent(const std::string &_cause, int c, Tick repeat = 0,
92                          bool serialize = false);
93
94    const std::string getCause() const { return cause; }
95    const int getCode() const { return code; }
96
97    void process();     // process event
98
99    virtual const char *description() const;
100
101    virtual void serialize(std::ostream &os);
102    virtual void unserialize(Checkpoint *cp, const std::string &section);
103    virtual void unserialize(Checkpoint *cp, const std::string &section,
104                             EventQueue *eventq);
105    static Serializable *createForUnserialize(Checkpoint *cp,
106                                              const std::string &section);
107};
108
109class CountedDrainEvent : public Event
110{
111  private:
112    // Count of how many objects have not yet drained
113    int count;
114
115  public:
116    CountedDrainEvent();
117
118    void process();
119
120    void setCount(int _count) { count = _count; }
121
122    const int getCount() const { return count; }
123};
124
125//
126// Event class to terminate simulation after 'n' related events have
127// occurred using a shared counter: used to terminate when *all*
128// threads have reached a particular instruction count
129//
130class CountedExitEvent : public Event
131{
132  private:
133    std::string cause;  // string explaining why we're terminating
134    int &downCounter;   // decrement & terminate if zero
135
136  public:
137    CountedExitEvent(const std::string &_cause, int &_downCounter);
138
139    void process();     // process event
140
141    virtual const char *description() const;
142};
143
144
145#endif  // __SIM_SIM_EVENTS_HH__
146