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