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#include "sim/sim_events.hh"
46
47#include <string>
48
49#include "base/callback.hh"
50#include "base/hostinfo.hh"
51#include "sim/eventq_impl.hh"
52#include "sim/sim_exit.hh"
53#include "sim/stats.hh"
54
55using namespace std;
56
57GlobalSimLoopExitEvent::GlobalSimLoopExitEvent(Tick when,
58                                               const std::string &_cause,
59                                               int c, Tick r)
60    : GlobalEvent(when, Sim_Exit_Pri, IsExitEvent),
61      cause(_cause), code(c), repeat(r)
62{
63}
64
65GlobalSimLoopExitEvent::GlobalSimLoopExitEvent(const std::string &_cause,
66                                               int c, Tick r)
67    : GlobalEvent(curTick(), Minimum_Pri, IsExitEvent),
68      cause(_cause), code(c), repeat(r)
69{
70}
71
72const char *
73GlobalSimLoopExitEvent::description() const
74{
75    return "global simulation loop exit";
76}
77
78//
79// handle termination event
80//
81void
82GlobalSimLoopExitEvent::process()
83{
84    if (repeat) {
85        schedule(curTick() + repeat);
86    }
87}
88
89void
90exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat,
91            bool serialize)
92{
93    warn_if(serialize && (when != curTick() || repeat),
94            "exitSimLoop called with a delay and auto serialization. This is "
95            "currently unsupported.");
96
97    new GlobalSimLoopExitEvent(when + simQuantum, message, exit_code, repeat);
98}
99
100void
101exitSimLoopNow(const std::string &message, int exit_code, Tick repeat,
102               bool serialize)
103{
104    new GlobalSimLoopExitEvent(message, exit_code, repeat);
105}
106
107LocalSimLoopExitEvent::LocalSimLoopExitEvent(const std::string &_cause, int c,
108                                   Tick r)
109    : Event(Sim_Exit_Pri, IsExitEvent),
110      cause(_cause), code(c), repeat(r)
111{
112}
113
114//
115// handle termination event
116//
117void
118LocalSimLoopExitEvent::process()
119{
120    exitSimLoop(cause, 0);
121}
122
123
124const char *
125LocalSimLoopExitEvent::description() const
126{
127    return "simulation loop exit";
128}
129
130void
131LocalSimLoopExitEvent::serialize(CheckpointOut &cp) const
132{
133    Event::serialize(cp);
134
135    SERIALIZE_SCALAR(cause);
136    SERIALIZE_SCALAR(code);
137    SERIALIZE_SCALAR(repeat);
138}
139
140void
141LocalSimLoopExitEvent::unserialize(CheckpointIn &cp)
142{
143    Event::unserialize(cp);
144
145    UNSERIALIZE_SCALAR(cause);
146    UNSERIALIZE_SCALAR(code);
147    UNSERIALIZE_SCALAR(repeat);
148}
149
150//
151// constructor: automatically schedules at specified time
152//
153CountedExitEvent::CountedExitEvent(const std::string &_cause, int &counter)
154    : Event(Sim_Exit_Pri), cause(_cause), downCounter(counter)
155{
156    // catch stupid mistakes
157    assert(downCounter > 0);
158}
159
160
161//
162// handle termination event
163//
164void
165CountedExitEvent::process()
166{
167    if (--downCounter == 0) {
168        exitSimLoop(cause, 0);
169    }
170}
171
172
173const char *
174CountedExitEvent::description() const
175{
176    return "counted exit";
177}
178