module.cc revision 13191:a2254693aa5b 
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#include "systemc/core/module.hh"
31
32#include <cassert>
33
34#include "base/logging.hh"
35#include "systemc/ext/core/sc_export.hh"
36#include "systemc/ext/core/sc_port.hh"
37#include "systemc/ext/utils/sc_report_handler.hh"
38
39namespace sc_gem5
40{
41
42namespace
43{
44
45std::list<Module *> _modules;
46Module *_new_module;
47
48Module *_callbackModule = nullptr;
49
50} // anonymous namespace
51
52Module::Module(const char *name) :
53    _name(name), _sc_mod(nullptr), _obj(nullptr), _ended(false),
54    _deprecatedConstructor(false)
55{
56    panic_if(_new_module, "Previous module not finished.\n");
57    _new_module = this;
58}
59
60Module::~Module()
61{
62    if (_new_module == this) {
63        // Aborted module construction?
64        _new_module = nullptr;
65    }
66    allModules.remove(this);
67}
68
69void
70Module::finish(Object *this_obj)
71{
72    assert(!_obj);
73    _obj = this_obj;
74    _modules.push_back(this);
75    _new_module = nullptr;
76    // This is called from the constructor of this_obj, so it can't use
77    // dynamic cast.
78    sc_mod(static_cast<::sc_core::sc_module *>(this_obj->sc_obj()));
79    allModules.emplace_back(this);
80}
81
82void
83Module::pop()
84{
85    panic_if(!_modules.size(), "Popping from empty module list.\n");
86    panic_if(_modules.back() != this,
87            "Popping module which isn't at the end of the module list.\n");
88    panic_if(_new_module, "Pop with unfinished module.\n");
89    _modules.pop_back();
90}
91
92void
93Module::bindPorts(std::vector<const ::sc_core::sc_bind_proxy *> &proxies)
94{
95    panic_if(proxies.size() > ports.size(),
96            "Trying to bind %d interfaces/ports to %d ports.\n",
97            proxies.size(), ports.size());
98
99    auto proxyIt = proxies.begin();
100    auto portIt = ports.begin();
101    for (; proxyIt != proxies.end(); proxyIt++, portIt++) {
102        auto proxy = *proxyIt;
103        auto port = *portIt;
104        if (proxy->interface())
105            port->vbind(*proxy->interface());
106        else
107            port->vbind(*proxy->port());
108    }
109}
110
111void
112Module::beforeEndOfElaboration()
113{
114    callbackModule(this);
115    _sc_mod->before_end_of_elaboration();
116    for (auto p: ports)
117        p->before_end_of_elaboration();
118    for (auto e: exports)
119        e->before_end_of_elaboration();
120    callbackModule(nullptr);
121}
122
123void
124Module::endOfElaboration()
125{
126    if (_deprecatedConstructor && !_ended) {
127        std::string msg = csprintf("module '%s'", name());
128        SC_REPORT_WARNING("(W509) module construction not properly completed: "
129                "did you forget to add a sc_module_name parameter to "
130                "your module constructor?", msg.c_str());
131    }
132    callbackModule(this);
133    _sc_mod->end_of_elaboration();
134    for (auto p: ports)
135        p->end_of_elaboration();
136    for (auto e: exports)
137        e->end_of_elaboration();
138    callbackModule(nullptr);
139}
140
141void
142Module::startOfSimulation()
143{
144    callbackModule(this);
145    _sc_mod->start_of_simulation();
146    for (auto p: ports)
147        p->start_of_simulation();
148    for (auto e: exports)
149        e->start_of_simulation();
150    callbackModule(nullptr);
151}
152
153void
154Module::endOfSimulation()
155{
156    callbackModule(this);
157    _sc_mod->end_of_simulation();
158    for (auto p: ports)
159        p->end_of_simulation();
160    for (auto e: exports)
161        e->end_of_simulation();
162    callbackModule(nullptr);
163}
164
165Module *
166currentModule()
167{
168    if (_modules.empty())
169        return nullptr;
170    return _modules.back();
171}
172
173Module *
174newModuleChecked()
175{
176    if (!_new_module) {
177        SC_REPORT_ERROR("(E533) module name stack is empty: "
178                "did you forget to add a sc_module_name parameter to "
179                "your module constructor?", nullptr);
180    }
181    return _new_module;
182}
183
184Module *
185newModule()
186{
187    return _new_module;
188}
189
190void callbackModule(Module *m) { _callbackModule = m; }
191Module *callbackModule() { return _callbackModule; }
192
193std::list<Module *> allModules;
194
195} // namespace sc_gem5
196