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

Generated on Wed Sep 30 2020 14:02:14 for gem5 by doxygen 1.8.17