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_CORE_MODULE_HH__
31#define __SYSTEMC_CORE_MODULE_HH__
32
33#include <cassert>
34#include <list>
35#include <map>
36#include <sstream>
37#include <string>
38#include <vector>
39
40#include "systemc/core/object.hh"
41#include "systemc/ext/core/sc_module.hh"
42
43namespace sc_core
44{
45
46class sc_port_base;
47class sc_export_base;
48
49} // namespace sc_core
50
51namespace sc_gem5
52{
53
54class UniqueNameGen
55{
56  private:
57    std::map<std::string, int> counts;
58    std::string buf;
59
60  public:
61    const char *
62    gen(std::string seed)
63    {
64        std::ostringstream os;
65        os << seed << "_" << counts[seed]++;
66        buf = os.str();
67        return buf.c_str();
68    }
69};
70
71extern UniqueNameGen globalNameGen;
72
73class Module
74{
75  private:
76    const char *_name;
77    sc_core::sc_module *_sc_mod;
78    Object *_obj;
79    bool _ended;
80    bool _deprecatedConstructor;
81
82    UniqueNameGen nameGen;
83
84  public:
85    Module(const char *name);
86    ~Module();
87
88    static Module *
89    fromScModule(::sc_core::sc_module *mod)
90    {
91        return mod->_gem5_module;
92    }
93
94    void finish(Object *this_obj);
95
96    const char *name() const { return _name; }
97    void endModule() { _ended = true; }
98    void deprecatedConstructor() { _deprecatedConstructor = true; }
99
100    sc_core::sc_module *
101    sc_mod() const
102    {
103        assert(_sc_mod);
104        return _sc_mod;
105    }
106
107    void
108    sc_mod(sc_core::sc_module *sc_mod)
109    {
110        assert(!_sc_mod);
111        _sc_mod = sc_mod;
112    }
113
114    Object *
115    obj()
116    {
117        assert(_obj);
118        return _obj;
119    }
120
121    void pop();
122
123    const char *uniqueName(const char *seed) { return nameGen.gen(seed); }
124
125    void bindPorts(std::vector<const ::sc_core::sc_bind_proxy *> &proxies);
126
127    std::vector<::sc_core::sc_port_base *> ports;
128    std::vector<::sc_core::sc_export_base *> exports;
129
130    int bindingIndex;
131
132    void beforeEndOfElaboration();
133    void endOfElaboration();
134    void startOfSimulation();
135    void endOfSimulation();
136};
137
138Module *currentModule();
139Module *newModuleChecked();
140Module *newModule();
141
142static inline Module *
143pickParentModule()
144{
145    ::sc_core::sc_object *obj = pickParentObj();
146    auto mod = dynamic_cast<::sc_core::sc_module *>(obj);
147    if (!mod)
148        return nullptr;
149    return Module::fromScModule(mod);
150}
151static inline void
152pushParentModule(Module *m)
153{
154    pushParentObj(m->obj()->sc_obj());
155}
156static inline void
157popParentModule()
158{
159    assert(pickParentModule());
160    popParentObj();
161}
162
163extern std::list<Module *> allModules;
164
165} // namespace sc_gem5
166
167#endif  //__SYSTEMC_CORE_MODULE_HH__
168