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    GlobalSimLoopExitEvent(Tick when, const std::string &_cause, int c,
64                           Tick repeat = 0);
65    GlobalSimLoopExitEvent(const std::string &_cause, int c, Tick repeat = 0);
66
67    const std::string getCause() const { return cause; }
68    int getCode() const { return code; }
69
70    void process();     // process event
71
72    virtual const char *description() const;
73};
74
75class LocalSimLoopExitEvent : public Event
76{
77  protected:
78    // string explaining why we're terminating
79    std::string cause;
80    int code;
81    Tick repeat;
82
83  public:
84    LocalSimLoopExitEvent();
85    LocalSimLoopExitEvent(const std::string &_cause, int c, Tick repeat = 0);
86
87    const std::string getCause() const { return cause; }
88    int getCode() const { return code; }
89
90    void process() override;     // process event
91
92    const char *description() const override;
93
94    void serialize(CheckpointOut &cp) const override;
95    void unserialize(CheckpointIn &cp) override;
96};
97
98//
99// Event class to terminate simulation after 'n' related events have
100// occurred using a shared counter: used to terminate when *all*
101// threads have reached a particular instruction count
102//
103class CountedExitEvent : public Event
104{
105  private:
106    std::string cause;  // string explaining why we're terminating
107    int &downCounter;   // decrement & terminate if zero
108
109  public:
110    CountedExitEvent(const std::string &_cause, int &_downCounter);
111
112    void process() override;     // process event
113
114    const char *description() const override;
115};
116
117
118#endif  // __SIM_SIM_EVENTS_HH__
119