module.cc revision 13079
112863Sgabeblack@google.com/* 212863Sgabeblack@google.com * Copyright 2018 Google, Inc. 312863Sgabeblack@google.com * 412863Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512863Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612863Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712863Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812863Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912863Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012863Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112863Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212863Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312863Sgabeblack@google.com * this software without specific prior written permission. 1412863Sgabeblack@google.com * 1512863Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612863Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712863Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812863Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912863Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012863Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112863Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212863Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312863Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412863Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512863Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612863Sgabeblack@google.com * 2712863Sgabeblack@google.com * Authors: Gabe Black 2812863Sgabeblack@google.com */ 2912863Sgabeblack@google.com 3012863Sgabeblack@google.com#include "systemc/core/module.hh" 3112863Sgabeblack@google.com 3212950Sgabeblack@google.com#include <cassert> 3312863Sgabeblack@google.com 3412863Sgabeblack@google.com#include "base/logging.hh" 3513079Sgabeblack@google.com#include "systemc/ext/utils/sc_report_handler.hh" 3612863Sgabeblack@google.com 3712950Sgabeblack@google.comnamespace sc_gem5 3812863Sgabeblack@google.com{ 3912863Sgabeblack@google.com 4012863Sgabeblack@google.comnamespace 4112863Sgabeblack@google.com{ 4212863Sgabeblack@google.com 4312863Sgabeblack@google.comstd::list<Module *> _modules; 4412950Sgabeblack@google.comModule *_new_module; 4512863Sgabeblack@google.com 4613045Sgabeblack@google.comModule *_callbackModule = nullptr; 4713045Sgabeblack@google.com 4812863Sgabeblack@google.com} // anonymous namespace 4912863Sgabeblack@google.com 5012950Sgabeblack@google.comModule::Module(const char *name) : _name(name), _sc_mod(nullptr), _obj(nullptr) 5112950Sgabeblack@google.com{ 5212950Sgabeblack@google.com panic_if(_new_module, "Previous module not finished.\n"); 5312950Sgabeblack@google.com _new_module = this; 5412950Sgabeblack@google.com} 5512950Sgabeblack@google.com 5613079Sgabeblack@google.comModule::~Module() 5713079Sgabeblack@google.com{ 5813079Sgabeblack@google.com if (_new_module == this) { 5913079Sgabeblack@google.com // Aborted module construction? 6013079Sgabeblack@google.com _new_module = nullptr; 6113079Sgabeblack@google.com } 6213079Sgabeblack@google.com allModules.remove(this); 6313079Sgabeblack@google.com} 6412982Sgabeblack@google.com 6512863Sgabeblack@google.comvoid 6612950Sgabeblack@google.comModule::finish(Object *this_obj) 6712863Sgabeblack@google.com{ 6812950Sgabeblack@google.com assert(!_obj); 6912950Sgabeblack@google.com _obj = this_obj; 7012863Sgabeblack@google.com _modules.push_back(this); 7112950Sgabeblack@google.com _new_module = nullptr; 7212982Sgabeblack@google.com // This is called from the constructor of this_obj, so it can't use 7312982Sgabeblack@google.com // dynamic cast. 7412982Sgabeblack@google.com sc_mod(static_cast<::sc_core::sc_module *>(this_obj->sc_obj())); 7513046Sgabeblack@google.com allModules.emplace_back(this); 7612863Sgabeblack@google.com} 7712863Sgabeblack@google.com 7812863Sgabeblack@google.comvoid 7912863Sgabeblack@google.comModule::pop() 8012863Sgabeblack@google.com{ 8112950Sgabeblack@google.com panic_if(!_modules.size(), "Popping from empty module list.\n"); 8212863Sgabeblack@google.com panic_if(_modules.back() != this, 8312863Sgabeblack@google.com "Popping module which isn't at the end of the module list.\n"); 8412950Sgabeblack@google.com panic_if(_new_module, "Pop with unfinished module.\n"); 8512950Sgabeblack@google.com _modules.pop_back(); 8612863Sgabeblack@google.com} 8712863Sgabeblack@google.com 8812863Sgabeblack@google.comModule * 8912950Sgabeblack@google.comcurrentModule() 9012863Sgabeblack@google.com{ 9112950Sgabeblack@google.com if (_modules.empty()) 9212950Sgabeblack@google.com return nullptr; 9312950Sgabeblack@google.com return _modules.back(); 9412863Sgabeblack@google.com} 9512863Sgabeblack@google.com 9612950Sgabeblack@google.comModule * 9713079Sgabeblack@google.comnewModuleChecked() 9813079Sgabeblack@google.com{ 9913079Sgabeblack@google.com if (!_new_module) { 10013079Sgabeblack@google.com SC_REPORT_ERROR("(E533) module name stack is empty: " 10113079Sgabeblack@google.com "did you forget to add a sc_module_name parameter to " 10213079Sgabeblack@google.com "your module constructor?", nullptr); 10313079Sgabeblack@google.com } 10413079Sgabeblack@google.com return _new_module; 10513079Sgabeblack@google.com} 10613079Sgabeblack@google.com 10713079Sgabeblack@google.comModule * 10812950Sgabeblack@google.comnewModule() 10912950Sgabeblack@google.com{ 11012950Sgabeblack@google.com return _new_module; 11112950Sgabeblack@google.com} 11212950Sgabeblack@google.com 11313045Sgabeblack@google.comvoid callbackModule(Module *m) { _callbackModule = m; } 11413045Sgabeblack@google.comModule *callbackModule() { return _callbackModule; } 11513045Sgabeblack@google.com 11613046Sgabeblack@google.comstd::list<Module *> allModules; 11712982Sgabeblack@google.com 11812950Sgabeblack@google.com} // namespace sc_gem5 119