module.cc revision 13079:e7e261dd975b 
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/utils/sc_report_handler.hh"
36
37namespace sc_gem5
38{
39
40namespace
41{
42
43std::list<Module *> _modules;
44Module *_new_module;
45
46Module *_callbackModule = nullptr;
47
48} // anonymous namespace
49
50Module::Module(const char *name) : _name(name), _sc_mod(nullptr), _obj(nullptr)
51{
52    panic_if(_new_module, "Previous module not finished.\n");
53    _new_module = this;
54}
55
56Module::~Module()
57{
58    if (_new_module == this) {
59        // Aborted module construction?
60        _new_module = nullptr;
61    }
62    allModules.remove(this);
63}
64
65void
66Module::finish(Object *this_obj)
67{
68    assert(!_obj);
69    _obj = this_obj;
70    _modules.push_back(this);
71    _new_module = nullptr;
72    // This is called from the constructor of this_obj, so it can't use
73    // dynamic cast.
74    sc_mod(static_cast<::sc_core::sc_module *>(this_obj->sc_obj()));
75    allModules.emplace_back(this);
76}
77
78void
79Module::pop()
80{
81    panic_if(!_modules.size(), "Popping from empty module list.\n");
82    panic_if(_modules.back() != this,
83            "Popping module which isn't at the end of the module list.\n");
84    panic_if(_new_module, "Pop with unfinished module.\n");
85    _modules.pop_back();
86}
87
88Module *
89currentModule()
90{
91    if (_modules.empty())
92        return nullptr;
93    return _modules.back();
94}
95
96Module *
97newModuleChecked()
98{
99    if (!_new_module) {
100        SC_REPORT_ERROR("(E533) module name stack is empty: "
101                "did you forget to add a sc_module_name parameter to "
102                "your module constructor?", nullptr);
103    }
104    return _new_module;
105}
106
107Module *
108newModule()
109{
110    return _new_module;
111}
112
113void callbackModule(Module *m) { _callbackModule = m; }
114Module *callbackModule() { return _callbackModule; }
115
116std::list<Module *> allModules;
117
118} // namespace sc_gem5
119