gem5  v21.1.0.2
sim_events.cc
Go to the documentation of this file.
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 
43 #include "sim/sim_events.hh"
44 
45 #include <string>
46 
47 #include "base/callback.hh"
48 #include "sim/eventq.hh"
49 #include "sim/sim_exit.hh"
50 #include "sim/stats.hh"
51 
52 namespace gem5
53 {
54 
56  const std::string &_cause,
57  int c, Tick r)
58  : GlobalEvent(when, Sim_Exit_Pri, IsExitEvent),
59  cause(_cause), code(c), repeat(r)
60 {
61 }
62 
64  int c, Tick r)
65  : GlobalEvent(curTick(), Minimum_Pri, IsExitEvent),
66  cause(_cause), code(c), repeat(r)
67 {
68 }
69 
70 const char *
72 {
73  return "global simulation loop exit";
74 }
75 
76 //
77 // handle termination event
78 //
79 void
81 {
82  if (repeat) {
83  schedule(curTick() + repeat);
84  }
85 }
86 
87 void
88 exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat,
89  bool serialize)
90 {
91  warn_if(serialize && (when != curTick() || repeat),
92  "exitSimLoop called with a delay and auto serialization. This is "
93  "currently unsupported.");
94 
95  new GlobalSimLoopExitEvent(when + simQuantum, message, exit_code, repeat);
96 }
97 
98 void
99 exitSimLoopNow(const std::string &message, int exit_code, Tick repeat,
100  bool serialize)
101 {
102  new GlobalSimLoopExitEvent(message, exit_code, repeat);
103 }
104 
105 LocalSimLoopExitEvent::LocalSimLoopExitEvent(const std::string &_cause, int c,
106  Tick r)
107  : Event(Sim_Exit_Pri, IsExitEvent),
108  cause(_cause), code(c), repeat(r)
109 {
110 }
111 
112 //
113 // handle termination event
114 //
115 void
117 {
118  exitSimLoop(cause, 0);
119 }
120 
121 
122 const char *
124 {
125  return "simulation loop exit";
126 }
127 
128 void
130 {
131  Event::serialize(cp);
132 
136 }
137 
138 void
140 {
141  Event::unserialize(cp);
142 
146 }
147 
148 //
149 // constructor: automatically schedules at specified time
150 //
151 CountedExitEvent::CountedExitEvent(const std::string &_cause, int &counter)
152  : Event(Sim_Exit_Pri), cause(_cause), downCounter(counter)
153 {
154  // catch stupid mistakes
155  assert(downCounter > 0);
156 }
157 
158 
159 //
160 // handle termination event
161 //
162 void
164 {
165  if (--downCounter == 0) {
166  exitSimLoop(cause, 0);
167  }
168 }
169 
170 
171 const char *
173 {
174  return "counted exit";
175 }
176 
177 } // namespace gem5
gem5::LocalSimLoopExitEvent::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: sim_events.cc:129
gem5::curTick
Tick curTick()
The universal simulation clock.
Definition: cur_tick.hh:46
gem5::CountedExitEvent::CountedExitEvent
CountedExitEvent(const std::string &_cause, int &_downCounter)
Definition: sim_events.cc:151
UNSERIALIZE_SCALAR
#define UNSERIALIZE_SCALAR(scalar)
Definition: serialize.hh:575
gem5::GlobalSimLoopExitEvent::GlobalSimLoopExitEvent
GlobalSimLoopExitEvent(Tick when, const std::string &_cause, int c, Tick repeat=0)
Definition: sim_events.cc:55
sim_events.hh
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::BaseGlobalEvent::schedule
void schedule(Tick when)
Definition: global_event.cc:56
gem5::exitSimLoopNow
void exitSimLoopNow(const std::string &message, int exit_code, Tick repeat, bool serialize)
Schedule an event as above, but make it high priority so it runs before any normal events which are s...
Definition: sim_events.cc:99
gem5::CountedExitEvent::downCounter
int & downCounter
Definition: sim_events.hh:108
gem5::GlobalSimLoopExitEvent
Definition: sim_events.hh:55
gem5::GlobalSimLoopExitEvent::repeat
Tick repeat
Definition: sim_events.hh:61
gem5::LocalSimLoopExitEvent::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: sim_events.cc:139
sim_exit.hh
gem5::exitSimLoop
void exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat, bool serialize)
Schedule an event to exit the simulation loop (returning to Python) at the end of the current cycle (...
Definition: sim_events.cc:88
gem5::LocalSimLoopExitEvent::repeat
Tick repeat
Definition: sim_events.hh:82
stats.hh
gem5::Event
Definition: eventq.hh:251
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::LocalSimLoopExitEvent::process
void process() override
Definition: sim_events.cc:116
gem5::simQuantum
Tick simQuantum
Simulation Quantum for multiple eventq simulation.
Definition: eventq.cc:48
gem5::LocalSimLoopExitEvent::description
const char * description() const override
Return a C string describing the event.
Definition: sim_events.cc:123
gem5::serialize
void serialize(const ThreadContext &tc, CheckpointOut &cp)
Thread context serialization helpers.
Definition: thread_context.cc:157
gem5::ArmISA::c
Bitfield< 29 > c
Definition: misc_types.hh:53
gem5::GlobalSimLoopExitEvent::process
void process()
Definition: sim_events.cc:80
gem5::CountedExitEvent::description
const char * description() const override
Return a C string describing the event.
Definition: sim_events.cc:172
gem5::CountedExitEvent::cause
std::string cause
Definition: sim_events.hh:107
gem5::LocalSimLoopExitEvent::code
int code
Definition: sim_events.hh:81
gem5::GlobalEvent
The main global event class.
Definition: global_event.hh:176
SERIALIZE_SCALAR
#define SERIALIZE_SCALAR(scalar)
Definition: serialize.hh:568
gem5::GlobalSimLoopExitEvent::description
virtual const char * description() const
Definition: sim_events.cc:71
gem5::LocalSimLoopExitEvent::cause
std::string cause
Definition: sim_events.hh:80
warn_if
#define warn_if(cond,...)
Conditional warning macro that checks the supplied condition and only prints a warning if the conditi...
Definition: logging.hh:272
gem5::Event::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: eventq.cc:239
gem5::CountedExitEvent::process
void process() override
Definition: sim_events.cc:163
gem5::Event::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: eventq.cc:248
gem5::LocalSimLoopExitEvent::LocalSimLoopExitEvent
LocalSimLoopExitEvent()
gem5::MipsISA::r
r
Definition: pra_constants.hh:98
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
callback.hh
eventq.hh

Generated on Tue Sep 21 2021 12:25:48 for gem5 by doxygen 1.8.17