gem5  v21.1.0.2
kernel.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2018 Google, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met: redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer;
8  * redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution;
11  * neither the name of the copyright holders nor the names of its
12  * contributors may be used to endorse or promote products derived from
13  * this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef __SYSTEMC_KERNEL_HH__
29 #define __SYSTEMC_KERNEL_HH__
30 
31 #include "params/SystemC_Kernel.hh"
32 #include "sim/sim_object.hh"
34 
35 namespace sc_gem5
36 {
37 
38 /*
39  * This class represents the systemc kernel. There should be exactly one in
40  * the simulation. It receives gem5 SimObject lifecycle callbacks (init,
41  * regStats, etc.) and manages the lifecycle of the systemc simulation
42  * accordingly. It also acts as a collecting point for systemc related
43  * control functionality.
44  */
45 class Kernel : public gem5::SimObject
46 {
47  public:
48  typedef gem5::SystemC_KernelParams Params;
49  Kernel(const Params &params, int);
50 
51  void init() override;
52  void regStats() override;
53  void startup() override;
54 
55  void t0Handler();
56 
57  static sc_core::sc_status status();
58  static void status(sc_core::sc_status s);
59 
60  static void stop();
61 
62  static bool startOfSimulationComplete();
63  static bool endOfSimulationComplete();
64 
65  private:
66  static void stopWork();
67 
69 };
70 
71 extern Kernel *kernel;
72 
73 } // namespace sc_gem5
74 
75 #endif // __SYSTEMC_KERNEL_H__
sc_gem5::Kernel::regStats
void regStats() override
Callback to set stat parameters.
Definition: kernel.cc:86
gem5::EventWrapper
Definition: eventq.hh:1084
sc_gem5::Kernel::t0Event
gem5::EventWrapper< Kernel, &Kernel::t0Handler > t0Event
Definition: kernel.hh:68
sc_gem5::Kernel::stop
static void stop()
Definition: kernel.cc:141
sc_gem5::Kernel::endOfSimulationComplete
static bool endOfSimulationComplete()
Definition: kernel.cc:52
sc_gem5::Kernel::t0Handler
void t0Handler()
Definition: kernel.cc:170
sc_gem5::Kernel::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: kernel.cc:66
sc_gem5::kernel
Kernel * kernel
Definition: kernel.cc:182
sc_gem5::Kernel::Params
gem5::SystemC_KernelParams Params
Definition: kernel.hh:48
sc_gem5::Kernel
Definition: kernel.hh:45
gem5::SimObject::Params
SimObjectParams Params
Definition: sim_object.hh:170
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
sim_object.hh
sc_main.hh
gem5::ArmISA::s
Bitfield< 4 > s
Definition: misc_types.hh:561
sc_gem5::Kernel::stopWork
static void stopWork()
Definition: kernel.cc:150
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
sc_gem5::Kernel::startOfSimulationComplete
static bool startOfSimulationComplete()
Definition: kernel.cc:51
sc_gem5::Kernel::startup
void startup() override
startup() is the final initialization call before simulation.
Definition: kernel.cc:110
sc_core::sc_status
sc_status
Definition: sc_main.hh:81
sc_gem5
Definition: sc_clock.cc:41
sc_gem5::Kernel::status
static sc_core::sc_status status()
Definition: kernel.cc:54
sc_gem5::Kernel::Kernel
Kernel(const Params &params, int)
Definition: kernel.cc:57

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