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 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_KERNEL_HH__
31#define __SYSTEMC_KERNEL_HH__
32
33#include "params/SystemC_Kernel.hh"
34#include "sim/sim_object.hh"
35#include "systemc/ext/core/sc_main.hh"
36
37namespace sc_gem5
38{
39
40/*
41 * This class represents the systemc kernel. There should be exactly one in
42 * the simulation. It receives gem5 SimObject lifecycle callbacks (init,
43 * regStats, etc.) and manages the lifecycle of the systemc simulation
44 * accordingly. It also acts as a collecting point for systemc related
45 * control functionality.
46 */
47class Kernel : public SimObject
48{
49  public:
50    typedef SystemC_KernelParams Params;
51    Kernel(Params *params);
52
53    void init() override;
54    void regStats() override;
55    void startup() override;
56
57    void t0Handler();
58
59    static sc_core::sc_status status();
60    static void status(sc_core::sc_status s);
61
62    static void stop();
63
64    static bool startOfSimulationComplete();
65    static bool endOfSimulationComplete();
66
67  private:
68    static void stopWork();
69
70    EventWrapper<Kernel, &Kernel::t0Handler> t0Event;
71};
72
73extern Kernel *kernel;
74
75} // namespace sc_gem5
76
77#endif // __SYSTEMC_KERNEL_H__
78