object.cc revision 13179
112950Sgabeblack@google.com/* 212950Sgabeblack@google.com * Copyright 2018 Google, Inc. 312950Sgabeblack@google.com * 412950Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512950Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612950Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712950Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812950Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912950Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012950Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112950Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212950Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312950Sgabeblack@google.com * this software without specific prior written permission. 1412950Sgabeblack@google.com * 1512950Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612950Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712950Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812950Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912950Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012950Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112950Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212950Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312950Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412950Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512950Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612950Sgabeblack@google.com * 2712950Sgabeblack@google.com * Authors: Gabe Black 2812950Sgabeblack@google.com */ 2912950Sgabeblack@google.com 3012950Sgabeblack@google.com#include "systemc/core/object.hh" 3112950Sgabeblack@google.com 3212988Sgabeblack@google.com#include <algorithm> 3312988Sgabeblack@google.com 3412950Sgabeblack@google.com#include "base/logging.hh" 3513127Sgabeblack@google.com#include "systemc/core/event.hh" 3612950Sgabeblack@google.com#include "systemc/core/module.hh" 3712953Sgabeblack@google.com#include "systemc/core/scheduler.hh" 3813161Sgabeblack@google.com#include "systemc/ext/core/sc_module.hh" 3912950Sgabeblack@google.com 4012950Sgabeblack@google.comnamespace sc_gem5 4112950Sgabeblack@google.com{ 4212950Sgabeblack@google.com 4312950Sgabeblack@google.comnamespace 4412950Sgabeblack@google.com{ 4512950Sgabeblack@google.com 4612950Sgabeblack@google.comObjectsIt 4712950Sgabeblack@google.comfindObjectIn(Objects &objects, const std::string &name) 4812950Sgabeblack@google.com{ 4912950Sgabeblack@google.com ObjectsIt it; 5012950Sgabeblack@google.com for (it = objects.begin(); it != objects.end(); it++) 5112950Sgabeblack@google.com if (!strcmp((*it)->name(), name.c_str())) 5212950Sgabeblack@google.com break; 5312950Sgabeblack@google.com 5412950Sgabeblack@google.com return it; 5512950Sgabeblack@google.com} 5612950Sgabeblack@google.com 5712950Sgabeblack@google.comvoid 5812950Sgabeblack@google.comaddObject(Objects *objects, sc_core::sc_object *object) 5912950Sgabeblack@google.com{ 6012950Sgabeblack@google.com objects->emplace(objects->end(), object); 6112950Sgabeblack@google.com} 6212950Sgabeblack@google.com 6312950Sgabeblack@google.comvoid 6412950Sgabeblack@google.compopObject(Objects *objects, const std::string &name) 6512950Sgabeblack@google.com{ 6612950Sgabeblack@google.com ObjectsIt it = findObjectIn(*objects, name); 6712950Sgabeblack@google.com assert(it != objects->end()); 6812950Sgabeblack@google.com std::swap(objects->back(), *it); 6912950Sgabeblack@google.com objects->pop_back(); 7012950Sgabeblack@google.com} 7112950Sgabeblack@google.com 7213127Sgabeblack@google.combool 7313127Sgabeblack@google.comnameIsUnique(Objects *objects, Events *events, const std::string &name) 7413127Sgabeblack@google.com{ 7513127Sgabeblack@google.com for (auto obj: *objects) 7613127Sgabeblack@google.com if (!strcmp(obj->basename(), name.c_str())) 7713127Sgabeblack@google.com return false; 7813127Sgabeblack@google.com for (auto event: *events) 7913127Sgabeblack@google.com if (!strcmp(event->basename(), name.c_str())) 8013127Sgabeblack@google.com return false; 8113127Sgabeblack@google.com return true; 8213127Sgabeblack@google.com} 8313127Sgabeblack@google.com 8412950Sgabeblack@google.com} // anonymous namespace 8512950Sgabeblack@google.com 8613161Sgabeblack@google.comObject::Object(sc_core::sc_object *_sc_obj) : Object(_sc_obj, nullptr) {} 8712950Sgabeblack@google.com 8812955Sgabeblack@google.comObject::Object(sc_core::sc_object *_sc_obj, const char *obj_name) : 8913085Sgabeblack@google.com _sc_obj(_sc_obj), _basename(obj_name ? obj_name : ""), parent(nullptr) 9012950Sgabeblack@google.com{ 9112950Sgabeblack@google.com if (_basename == "") 9213161Sgabeblack@google.com _basename = ::sc_core::sc_gen_unique_name("object"); 9312950Sgabeblack@google.com 9412950Sgabeblack@google.com Module *p = currentModule(); 9513045Sgabeblack@google.com if (!p) 9613045Sgabeblack@google.com p = callbackModule(); 9712950Sgabeblack@google.com 9812950Sgabeblack@google.com Module *n = newModule(); 9912950Sgabeblack@google.com if (n) { 10012950Sgabeblack@google.com // We are a module in the process of being constructed. 10112950Sgabeblack@google.com n->finish(this); 10212950Sgabeblack@google.com } 10312950Sgabeblack@google.com 10412950Sgabeblack@google.com if (p) { 10512950Sgabeblack@google.com // We're "within" a parent module, ie we're being created while its 10613045Sgabeblack@google.com // constructor or end_of_elaboration callback is running. 10712955Sgabeblack@google.com parent = p->obj()->_sc_obj; 10812953Sgabeblack@google.com } else if (scheduler.current()) { 10912953Sgabeblack@google.com // Our parent is the currently running process. 11012953Sgabeblack@google.com parent = scheduler.current(); 11113126Sgabeblack@google.com } 11213127Sgabeblack@google.com 11313179Sgabeblack@google.com std::string original_name = _basename; 11413179Sgabeblack@google.com _basename = sc_gem5::pickUniqueName(parent, original_name); 11513127Sgabeblack@google.com 11613127Sgabeblack@google.com if (parent) 11713126Sgabeblack@google.com addObject(&parent->_gem5_object->children, _sc_obj); 11813127Sgabeblack@google.com else 11912955Sgabeblack@google.com addObject(&topLevelObjects, _sc_obj); 12012950Sgabeblack@google.com 12112955Sgabeblack@google.com addObject(&allObjects, _sc_obj); 12212950Sgabeblack@google.com 12312950Sgabeblack@google.com sc_core::sc_object *sc_p = parent; 12413179Sgabeblack@google.com std::string path = ""; 12512950Sgabeblack@google.com while (sc_p) { 12613179Sgabeblack@google.com path = std::string(sc_p->basename()) + std::string(".") + path; 12712952Sgabeblack@google.com sc_p = sc_p->get_parent_object(); 12812950Sgabeblack@google.com } 12913179Sgabeblack@google.com 13013179Sgabeblack@google.com if (_basename != original_name) { 13113179Sgabeblack@google.com std::string message = path + original_name + 13213179Sgabeblack@google.com ". Latter declaration will be renamed to " + 13313179Sgabeblack@google.com path + _basename; 13413179Sgabeblack@google.com SC_REPORT_WARNING("(W505) object already exists", message.c_str()); 13513179Sgabeblack@google.com } 13613179Sgabeblack@google.com _name = path + _basename; 13712950Sgabeblack@google.com} 13812950Sgabeblack@google.com 13912955Sgabeblack@google.comObject::Object(sc_core::sc_object *_sc_obj, const Object &arg) : 14012955Sgabeblack@google.com Object(_sc_obj, arg._basename.c_str()) 14112950Sgabeblack@google.com{} 14212950Sgabeblack@google.com 14312950Sgabeblack@google.comObject & 14412950Sgabeblack@google.comObject::operator = (const Object &) 14512950Sgabeblack@google.com{ 14612950Sgabeblack@google.com return *this; 14712950Sgabeblack@google.com} 14812950Sgabeblack@google.com 14912950Sgabeblack@google.comObject::~Object() 15012950Sgabeblack@google.com{ 15112984Sgabeblack@google.com // Promote all children to be top level objects. 15212984Sgabeblack@google.com for (auto child: children) { 15312984Sgabeblack@google.com addObject(&topLevelObjects, child); 15412984Sgabeblack@google.com child->_gem5_object->parent = nullptr; 15512984Sgabeblack@google.com } 15612984Sgabeblack@google.com children.clear(); 15712950Sgabeblack@google.com 15812950Sgabeblack@google.com if (parent) 15912950Sgabeblack@google.com popObject(&parent->_gem5_object->children, _name); 16012950Sgabeblack@google.com else 16112950Sgabeblack@google.com popObject(&topLevelObjects, _name); 16212950Sgabeblack@google.com popObject(&allObjects, _name); 16312950Sgabeblack@google.com} 16412950Sgabeblack@google.com 16512950Sgabeblack@google.comconst char * 16612950Sgabeblack@google.comObject::name() const 16712950Sgabeblack@google.com{ 16812950Sgabeblack@google.com return _name.c_str(); 16912950Sgabeblack@google.com} 17012950Sgabeblack@google.com 17112950Sgabeblack@google.comconst char * 17212950Sgabeblack@google.comObject::basename() const 17312950Sgabeblack@google.com{ 17412950Sgabeblack@google.com return _basename.c_str(); 17512950Sgabeblack@google.com} 17612950Sgabeblack@google.com 17712950Sgabeblack@google.comvoid 17812950Sgabeblack@google.comObject::print(std::ostream &out) const 17912950Sgabeblack@google.com{ 18012950Sgabeblack@google.com out << name(); 18112950Sgabeblack@google.com} 18212950Sgabeblack@google.com 18312950Sgabeblack@google.comvoid 18412950Sgabeblack@google.comObject::dump(std::ostream &out) const 18512950Sgabeblack@google.com{ 18612950Sgabeblack@google.com out << "name = " << name() << "\n"; 18712955Sgabeblack@google.com out << "kind = " << _sc_obj->kind() << "\n"; 18812950Sgabeblack@google.com} 18912950Sgabeblack@google.com 19012950Sgabeblack@google.comconst std::vector<sc_core::sc_object *> & 19112950Sgabeblack@google.comObject::get_child_objects() const 19212950Sgabeblack@google.com{ 19312950Sgabeblack@google.com return children; 19412950Sgabeblack@google.com} 19512950Sgabeblack@google.com 19612950Sgabeblack@google.comconst std::vector<sc_core::sc_event *> & 19712950Sgabeblack@google.comObject::get_child_events() const 19812950Sgabeblack@google.com{ 19912950Sgabeblack@google.com return events; 20012950Sgabeblack@google.com} 20112950Sgabeblack@google.com 20212950Sgabeblack@google.comsc_core::sc_object *Object::get_parent_object() const 20312950Sgabeblack@google.com{ 20412950Sgabeblack@google.com return parent; 20512950Sgabeblack@google.com} 20612950Sgabeblack@google.com 20712950Sgabeblack@google.combool 20812950Sgabeblack@google.comObject::add_attribute(sc_core::sc_attr_base &attr) 20912950Sgabeblack@google.com{ 21012950Sgabeblack@google.com return cltn.push_back(&attr); 21112950Sgabeblack@google.com} 21212950Sgabeblack@google.com 21312950Sgabeblack@google.comsc_core::sc_attr_base * 21412950Sgabeblack@google.comObject::get_attribute(const std::string &attr) 21512950Sgabeblack@google.com{ 21612950Sgabeblack@google.com return cltn[attr]; 21712950Sgabeblack@google.com} 21812950Sgabeblack@google.com 21912950Sgabeblack@google.comsc_core::sc_attr_base * 22012950Sgabeblack@google.comObject::remove_attribute(const std::string &attr) 22112950Sgabeblack@google.com{ 22212950Sgabeblack@google.com return cltn.remove(attr); 22312950Sgabeblack@google.com} 22412950Sgabeblack@google.com 22512950Sgabeblack@google.comvoid 22612950Sgabeblack@google.comObject::remove_all_attributes() 22712950Sgabeblack@google.com{ 22812950Sgabeblack@google.com cltn.remove_all(); 22912950Sgabeblack@google.com} 23012950Sgabeblack@google.com 23112950Sgabeblack@google.comint 23212950Sgabeblack@google.comObject::num_attributes() const 23312950Sgabeblack@google.com{ 23412950Sgabeblack@google.com return cltn.size(); 23512950Sgabeblack@google.com} 23612950Sgabeblack@google.com 23712950Sgabeblack@google.comsc_core::sc_attr_cltn & 23812950Sgabeblack@google.comObject::attr_cltn() 23912950Sgabeblack@google.com{ 24012950Sgabeblack@google.com return cltn; 24112950Sgabeblack@google.com} 24212950Sgabeblack@google.com 24312950Sgabeblack@google.comconst sc_core::sc_attr_cltn & 24412950Sgabeblack@google.comObject::attr_cltn() const 24512950Sgabeblack@google.com{ 24612950Sgabeblack@google.com return cltn; 24712950Sgabeblack@google.com} 24812950Sgabeblack@google.com 24912950Sgabeblack@google.comsc_core::sc_simcontext * 25012950Sgabeblack@google.comObject::simcontext() const 25112950Sgabeblack@google.com{ 25212950Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 25312950Sgabeblack@google.com return nullptr; 25412950Sgabeblack@google.com} 25512950Sgabeblack@google.com 25612955Sgabeblack@google.comEventsIt 25712955Sgabeblack@google.comObject::addChildEvent(sc_core::sc_event *e) 25812955Sgabeblack@google.com{ 25912955Sgabeblack@google.com return events.emplace(events.end(), e); 26012955Sgabeblack@google.com} 26112955Sgabeblack@google.com 26212955Sgabeblack@google.comvoid 26312988Sgabeblack@google.comObject::delChildEvent(sc_core::sc_event *e) 26412955Sgabeblack@google.com{ 26512988Sgabeblack@google.com EventsIt it = std::find(events.begin(), events.end(), e); 26612988Sgabeblack@google.com assert(it != events.end()); 26712955Sgabeblack@google.com std::swap(*it, events.back()); 26812955Sgabeblack@google.com events.pop_back(); 26912955Sgabeblack@google.com} 27012955Sgabeblack@google.com 27113179Sgabeblack@google.comstd::string 27213179Sgabeblack@google.comObject::pickUniqueName(std::string base) 27313127Sgabeblack@google.com{ 27413127Sgabeblack@google.com std::string seed = base; 27513127Sgabeblack@google.com while (!nameIsUnique(&children, &events, base)) 27613127Sgabeblack@google.com base = ::sc_core::sc_gen_unique_name(seed.c_str()); 27713179Sgabeblack@google.com 27813179Sgabeblack@google.com return base; 27913127Sgabeblack@google.com} 28013127Sgabeblack@google.com 28113179Sgabeblack@google.comstd::string 28213179Sgabeblack@google.compickUniqueName(::sc_core::sc_object *parent, std::string base) 28313127Sgabeblack@google.com{ 28413179Sgabeblack@google.com if (parent) 28513179Sgabeblack@google.com return Object::getFromScObject(parent)->pickUniqueName(base); 28613127Sgabeblack@google.com 28713127Sgabeblack@google.com std::string seed = base; 28813127Sgabeblack@google.com while (!nameIsUnique(&topLevelObjects, &topLevelEvents, base)) 28913127Sgabeblack@google.com base = ::sc_core::sc_gen_unique_name(seed.c_str()); 29013179Sgabeblack@google.com 29113179Sgabeblack@google.com return base; 29213127Sgabeblack@google.com} 29313127Sgabeblack@google.com 29412950Sgabeblack@google.com 29512950Sgabeblack@google.comObjects topLevelObjects; 29612950Sgabeblack@google.comObjects allObjects; 29712950Sgabeblack@google.com 29812950Sgabeblack@google.comconst std::vector<sc_core::sc_object *> & 29912950Sgabeblack@google.comgetTopLevelScObjects() 30012950Sgabeblack@google.com{ 30112950Sgabeblack@google.com return topLevelObjects; 30212950Sgabeblack@google.com} 30312950Sgabeblack@google.com 30412950Sgabeblack@google.comsc_core::sc_object * 30512950Sgabeblack@google.comfindObject(const char *name, const Objects &objects) 30612950Sgabeblack@google.com{ 30712950Sgabeblack@google.com ObjectsIt it = findObjectIn(allObjects, name); 30812950Sgabeblack@google.com return it == allObjects.end() ? nullptr : *it; 30912950Sgabeblack@google.com} 31012950Sgabeblack@google.com 31112950Sgabeblack@google.com} // namespace sc_gem5 312