gem5  v21.1.0.2
sim_events.hh
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 #ifndef __SIM_SIM_EVENTS_HH__
44 #define __SIM_SIM_EVENTS_HH__
45 
46 #include "sim/global_event.hh"
47 #include "sim/serialize.hh"
48 
49 namespace gem5
50 {
51 
52 //
53 // Event to terminate simulation at a particular cycle/instruction
54 //
56 {
57  protected:
58  // string explaining why we're terminating
59  std::string cause;
60  int code;
62 
63  public:
64  GlobalSimLoopExitEvent(Tick when, const std::string &_cause, int c,
65  Tick repeat = 0);
66  GlobalSimLoopExitEvent(const std::string &_cause, int c, Tick repeat = 0);
67 
68  const std::string getCause() const { return cause; }
69  int getCode() const { return code; }
70 
71  void process(); // process event
72 
73  virtual const char *description() const;
74 };
75 
77 {
78  protected:
79  // string explaining why we're terminating
80  std::string cause;
81  int code;
83 
84  public:
86  LocalSimLoopExitEvent(const std::string &_cause, int c, Tick repeat = 0);
87 
88  const std::string getCause() const { return cause; }
89  int getCode() const { return code; }
90 
91  void process() override; // process event
92 
93  const char *description() const override;
94 
95  void serialize(CheckpointOut &cp) const override;
96  void unserialize(CheckpointIn &cp) override;
97 };
98 
99 //
100 // Event class to terminate simulation after 'n' related events have
101 // occurred using a shared counter: used to terminate when *all*
102 // threads have reached a particular instruction count
103 //
104 class CountedExitEvent : public Event
105 {
106  private:
107  std::string cause; // string explaining why we're terminating
108  int &downCounter; // decrement & terminate if zero
109 
110  public:
111  CountedExitEvent(const std::string &_cause, int &_downCounter);
112 
113  void process() override; // process event
114 
115  const char *description() const override;
116 };
117 
118 } // namespace gem5
119 
120 #endif // __SIM_SIM_EVENTS_HH__
gem5::LocalSimLoopExitEvent::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: sim_events.cc:129
gem5::CountedExitEvent::CountedExitEvent
CountedExitEvent(const std::string &_cause, int &_downCounter)
Definition: sim_events.cc:151
serialize.hh
gem5::GlobalSimLoopExitEvent::GlobalSimLoopExitEvent
GlobalSimLoopExitEvent(Tick when, const std::string &_cause, int c, Tick repeat=0)
Definition: sim_events.cc:55
gem5::GlobalSimLoopExitEvent::code
int code
Definition: sim_events.hh:60
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::GlobalSimLoopExitEvent::getCode
int getCode() const
Definition: sim_events.hh:69
gem5::LocalSimLoopExitEvent::getCode
int getCode() const
Definition: sim_events.hh:89
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
gem5::LocalSimLoopExitEvent::repeat
Tick repeat
Definition: sim_events.hh:82
gem5::Event
Definition: eventq.hh:251
gem5::GlobalSimLoopExitEvent::getCause
const std::string getCause() const
Definition: sim_events.hh:68
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::LocalSimLoopExitEvent::process
void process() override
Definition: sim_events.cc:116
gem5::LocalSimLoopExitEvent::description
const char * description() const override
Return a C string describing the event.
Definition: sim_events.cc:123
gem5::ArmISA::c
Bitfield< 29 > c
Definition: misc_types.hh:53
gem5::GlobalSimLoopExitEvent::process
void process()
Definition: sim_events.cc:80
gem5::BaseGlobalEvent::when
Tick when() const
Definition: global_event.hh:139
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::CountedExitEvent
Definition: sim_events.hh:104
gem5::GlobalEvent
The main global event class.
Definition: global_event.hh:176
gem5::LocalSimLoopExitEvent
Definition: sim_events.hh:76
gem5::GlobalSimLoopExitEvent::description
virtual const char * description() const
Definition: sim_events.cc:71
gem5::LocalSimLoopExitEvent::cause
std::string cause
Definition: sim_events.hh:80
gem5::CountedExitEvent::process
void process() override
Definition: sim_events.cc:163
gem5::LocalSimLoopExitEvent::LocalSimLoopExitEvent
LocalSimLoopExitEvent()
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
global_event.hh
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::GlobalSimLoopExitEvent::cause
std::string cause
Definition: sim_events.hh:59
gem5::LocalSimLoopExitEvent::getCause
const std::string getCause() const
Definition: sim_events.hh:88

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