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>
3313268Sgabeblack@google.com#include <stack>
3412988Sgabeblack@google.com
3513127Sgabeblack@google.com#include "systemc/core/event.hh"
3612950Sgabeblack@google.com#include "systemc/core/module.hh"
3712953Sgabeblack@google.com#include "systemc/core/scheduler.hh"
3813317Sgabeblack@google.com#include "systemc/ext/core/messages.hh"
3913161Sgabeblack@google.com#include "systemc/ext/core/sc_module.hh"
4013334Sgabeblack@google.com#include "systemc/ext/core/sc_simcontext.hh"
4112950Sgabeblack@google.com
4212950Sgabeblack@google.comnamespace sc_gem5
4312950Sgabeblack@google.com{
4412950Sgabeblack@google.com
4512950Sgabeblack@google.comnamespace
4612950Sgabeblack@google.com{
4712950Sgabeblack@google.com
4812950Sgabeblack@google.comObjectsIt
4912950Sgabeblack@google.comfindObjectIn(Objects &objects, const std::string &name)
5012950Sgabeblack@google.com{
5112950Sgabeblack@google.com    ObjectsIt it;
5212950Sgabeblack@google.com    for (it = objects.begin(); it != objects.end(); it++)
5312950Sgabeblack@google.com        if (!strcmp((*it)->name(), name.c_str()))
5412950Sgabeblack@google.com            break;
5512950Sgabeblack@google.com
5612950Sgabeblack@google.com    return it;
5712950Sgabeblack@google.com}
5812950Sgabeblack@google.com
5912950Sgabeblack@google.comvoid
6012950Sgabeblack@google.comaddObject(Objects *objects, sc_core::sc_object *object)
6112950Sgabeblack@google.com{
6212950Sgabeblack@google.com    objects->emplace(objects->end(), object);
6312950Sgabeblack@google.com}
6412950Sgabeblack@google.com
6512950Sgabeblack@google.comvoid
6612950Sgabeblack@google.compopObject(Objects *objects, const std::string &name)
6712950Sgabeblack@google.com{
6812950Sgabeblack@google.com    ObjectsIt it = findObjectIn(*objects, name);
6912950Sgabeblack@google.com    assert(it != objects->end());
7012950Sgabeblack@google.com    std::swap(objects->back(), *it);
7112950Sgabeblack@google.com    objects->pop_back();
7212950Sgabeblack@google.com}
7312950Sgabeblack@google.com
7413127Sgabeblack@google.combool
7513127Sgabeblack@google.comnameIsUnique(Objects *objects, Events *events, const std::string &name)
7613127Sgabeblack@google.com{
7713127Sgabeblack@google.com    for (auto obj: *objects)
7813127Sgabeblack@google.com        if (!strcmp(obj->basename(), name.c_str()))
7913127Sgabeblack@google.com            return false;
8013127Sgabeblack@google.com    for (auto event: *events)
8113127Sgabeblack@google.com        if (!strcmp(event->basename(), name.c_str()))
8213127Sgabeblack@google.com            return false;
8313127Sgabeblack@google.com    return true;
8413127Sgabeblack@google.com}
8513127Sgabeblack@google.com
8612950Sgabeblack@google.com} // anonymous namespace
8712950Sgabeblack@google.com
8813161Sgabeblack@google.comObject::Object(sc_core::sc_object *_sc_obj) : Object(_sc_obj, nullptr) {}
8912950Sgabeblack@google.com
9012955Sgabeblack@google.comObject::Object(sc_core::sc_object *_sc_obj, const char *obj_name) :
9113085Sgabeblack@google.com    _sc_obj(_sc_obj), _basename(obj_name ? obj_name : ""), parent(nullptr)
9212950Sgabeblack@google.com{
9312950Sgabeblack@google.com    if (_basename == "")
9413161Sgabeblack@google.com        _basename = ::sc_core::sc_gen_unique_name("object");
9512950Sgabeblack@google.com
9613268Sgabeblack@google.com    parent = pickParentObj();
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
10413179Sgabeblack@google.com    std::string original_name = _basename;
10513179Sgabeblack@google.com    _basename = sc_gem5::pickUniqueName(parent, original_name);
10613127Sgabeblack@google.com
10713127Sgabeblack@google.com    if (parent)
10813126Sgabeblack@google.com        addObject(&parent->_gem5_object->children, _sc_obj);
10913127Sgabeblack@google.com    else
11012955Sgabeblack@google.com        addObject(&topLevelObjects, _sc_obj);
11112950Sgabeblack@google.com
11212955Sgabeblack@google.com    addObject(&allObjects, _sc_obj);
11312950Sgabeblack@google.com
11412950Sgabeblack@google.com    sc_core::sc_object *sc_p = parent;
11513179Sgabeblack@google.com    std::string path = "";
11612950Sgabeblack@google.com    while (sc_p) {
11713179Sgabeblack@google.com        path = std::string(sc_p->basename()) + std::string(".") + path;
11812952Sgabeblack@google.com        sc_p = sc_p->get_parent_object();
11912950Sgabeblack@google.com    }
12013179Sgabeblack@google.com
12113179Sgabeblack@google.com    if (_basename != original_name) {
12213179Sgabeblack@google.com        std::string message = path + original_name +
12313179Sgabeblack@google.com            ". Latter declaration will be renamed to " +
12413179Sgabeblack@google.com            path + _basename;
12513317Sgabeblack@google.com        SC_REPORT_WARNING(sc_core::SC_ID_INSTANCE_EXISTS_, message.c_str());
12613179Sgabeblack@google.com    }
12713179Sgabeblack@google.com    _name = path + _basename;
12812950Sgabeblack@google.com}
12912950Sgabeblack@google.com
13012955Sgabeblack@google.comObject::Object(sc_core::sc_object *_sc_obj, const Object &arg) :
13112955Sgabeblack@google.com    Object(_sc_obj, arg._basename.c_str())
13212950Sgabeblack@google.com{}
13312950Sgabeblack@google.com
13412950Sgabeblack@google.comObject &
13512950Sgabeblack@google.comObject::operator = (const Object &)
13612950Sgabeblack@google.com{
13712950Sgabeblack@google.com    return *this;
13812950Sgabeblack@google.com}
13912950Sgabeblack@google.com
14012950Sgabeblack@google.comObject::~Object()
14112950Sgabeblack@google.com{
14212984Sgabeblack@google.com    // Promote all children to be top level objects.
14312984Sgabeblack@google.com    for (auto child: children) {
14412984Sgabeblack@google.com        addObject(&topLevelObjects, child);
14512984Sgabeblack@google.com        child->_gem5_object->parent = nullptr;
14612984Sgabeblack@google.com    }
14712984Sgabeblack@google.com    children.clear();
14812950Sgabeblack@google.com
14913295Sgabeblack@google.com    for (auto event: events)
15013295Sgabeblack@google.com        Event::getFromScEvent(event)->clearParent();
15113295Sgabeblack@google.com
15212950Sgabeblack@google.com    if (parent)
15312950Sgabeblack@google.com        popObject(&parent->_gem5_object->children, _name);
15412950Sgabeblack@google.com    else
15512950Sgabeblack@google.com        popObject(&topLevelObjects, _name);
15612950Sgabeblack@google.com    popObject(&allObjects, _name);
15712950Sgabeblack@google.com}
15812950Sgabeblack@google.com
15912950Sgabeblack@google.comconst char *
16012950Sgabeblack@google.comObject::name() const
16112950Sgabeblack@google.com{
16212950Sgabeblack@google.com    return _name.c_str();
16312950Sgabeblack@google.com}
16412950Sgabeblack@google.com
16512950Sgabeblack@google.comconst char *
16612950Sgabeblack@google.comObject::basename() const
16712950Sgabeblack@google.com{
16812950Sgabeblack@google.com    return _basename.c_str();
16912950Sgabeblack@google.com}
17012950Sgabeblack@google.com
17112950Sgabeblack@google.comvoid
17212950Sgabeblack@google.comObject::print(std::ostream &out) const
17312950Sgabeblack@google.com{
17412950Sgabeblack@google.com    out << name();
17512950Sgabeblack@google.com}
17612950Sgabeblack@google.com
17712950Sgabeblack@google.comvoid
17812950Sgabeblack@google.comObject::dump(std::ostream &out) const
17912950Sgabeblack@google.com{
18012950Sgabeblack@google.com    out << "name = " << name() << "\n";
18112955Sgabeblack@google.com    out << "kind = " << _sc_obj->kind() << "\n";
18212950Sgabeblack@google.com}
18312950Sgabeblack@google.com
18412950Sgabeblack@google.comconst std::vector<sc_core::sc_object *> &
18512950Sgabeblack@google.comObject::get_child_objects() const
18612950Sgabeblack@google.com{
18712950Sgabeblack@google.com    return children;
18812950Sgabeblack@google.com}
18912950Sgabeblack@google.com
19012950Sgabeblack@google.comconst std::vector<sc_core::sc_event *> &
19112950Sgabeblack@google.comObject::get_child_events() const
19212950Sgabeblack@google.com{
19312950Sgabeblack@google.com    return events;
19412950Sgabeblack@google.com}
19512950Sgabeblack@google.com
19612950Sgabeblack@google.comsc_core::sc_object *Object::get_parent_object() const
19712950Sgabeblack@google.com{
19812950Sgabeblack@google.com    return parent;
19912950Sgabeblack@google.com}
20012950Sgabeblack@google.com
20112950Sgabeblack@google.combool
20212950Sgabeblack@google.comObject::add_attribute(sc_core::sc_attr_base &attr)
20312950Sgabeblack@google.com{
20412950Sgabeblack@google.com    return cltn.push_back(&attr);
20512950Sgabeblack@google.com}
20612950Sgabeblack@google.com
20712950Sgabeblack@google.comsc_core::sc_attr_base *
20812950Sgabeblack@google.comObject::get_attribute(const std::string &attr)
20912950Sgabeblack@google.com{
21012950Sgabeblack@google.com    return cltn[attr];
21112950Sgabeblack@google.com}
21212950Sgabeblack@google.com
21312950Sgabeblack@google.comsc_core::sc_attr_base *
21412950Sgabeblack@google.comObject::remove_attribute(const std::string &attr)
21512950Sgabeblack@google.com{
21612950Sgabeblack@google.com    return cltn.remove(attr);
21712950Sgabeblack@google.com}
21812950Sgabeblack@google.com
21912950Sgabeblack@google.comvoid
22012950Sgabeblack@google.comObject::remove_all_attributes()
22112950Sgabeblack@google.com{
22212950Sgabeblack@google.com    cltn.remove_all();
22312950Sgabeblack@google.com}
22412950Sgabeblack@google.com
22512950Sgabeblack@google.comint
22612950Sgabeblack@google.comObject::num_attributes() const
22712950Sgabeblack@google.com{
22812950Sgabeblack@google.com    return cltn.size();
22912950Sgabeblack@google.com}
23012950Sgabeblack@google.com
23112950Sgabeblack@google.comsc_core::sc_attr_cltn &
23212950Sgabeblack@google.comObject::attr_cltn()
23312950Sgabeblack@google.com{
23412950Sgabeblack@google.com    return cltn;
23512950Sgabeblack@google.com}
23612950Sgabeblack@google.com
23712950Sgabeblack@google.comconst sc_core::sc_attr_cltn &
23812950Sgabeblack@google.comObject::attr_cltn() const
23912950Sgabeblack@google.com{
24012950Sgabeblack@google.com    return cltn;
24112950Sgabeblack@google.com}
24212950Sgabeblack@google.com
24312950Sgabeblack@google.comsc_core::sc_simcontext *
24412950Sgabeblack@google.comObject::simcontext() const
24512950Sgabeblack@google.com{
24613334Sgabeblack@google.com    return sc_core::sc_get_curr_simcontext();
24712950Sgabeblack@google.com}
24812950Sgabeblack@google.com
24912955Sgabeblack@google.comEventsIt
25012955Sgabeblack@google.comObject::addChildEvent(sc_core::sc_event *e)
25112955Sgabeblack@google.com{
25212955Sgabeblack@google.com    return events.emplace(events.end(), e);
25312955Sgabeblack@google.com}
25412955Sgabeblack@google.com
25512955Sgabeblack@google.comvoid
25612988Sgabeblack@google.comObject::delChildEvent(sc_core::sc_event *e)
25712955Sgabeblack@google.com{
25812988Sgabeblack@google.com    EventsIt it = std::find(events.begin(), events.end(), e);
25912988Sgabeblack@google.com    assert(it != events.end());
26012955Sgabeblack@google.com    std::swap(*it, events.back());
26112955Sgabeblack@google.com    events.pop_back();
26212955Sgabeblack@google.com}
26312955Sgabeblack@google.com
26413179Sgabeblack@google.comstd::string
26513179Sgabeblack@google.comObject::pickUniqueName(std::string base)
26613127Sgabeblack@google.com{
26713127Sgabeblack@google.com    std::string seed = base;
26813127Sgabeblack@google.com    while (!nameIsUnique(&children, &events, base))
26913127Sgabeblack@google.com        base = ::sc_core::sc_gen_unique_name(seed.c_str());
27013179Sgabeblack@google.com
27113179Sgabeblack@google.com    return base;
27213127Sgabeblack@google.com}
27313127Sgabeblack@google.com
27413179Sgabeblack@google.comstd::string
27513179Sgabeblack@google.compickUniqueName(::sc_core::sc_object *parent, std::string base)
27613127Sgabeblack@google.com{
27713179Sgabeblack@google.com    if (parent)
27813179Sgabeblack@google.com        return Object::getFromScObject(parent)->pickUniqueName(base);
27913127Sgabeblack@google.com
28013127Sgabeblack@google.com    std::string seed = base;
28113127Sgabeblack@google.com    while (!nameIsUnique(&topLevelObjects, &topLevelEvents, base))
28213127Sgabeblack@google.com        base = ::sc_core::sc_gen_unique_name(seed.c_str());
28313179Sgabeblack@google.com
28413179Sgabeblack@google.com    return base;
28513127Sgabeblack@google.com}
28613127Sgabeblack@google.com
28712950Sgabeblack@google.com
28812950Sgabeblack@google.comObjects topLevelObjects;
28912950Sgabeblack@google.comObjects allObjects;
29012950Sgabeblack@google.com
29112950Sgabeblack@google.comconst std::vector<sc_core::sc_object *> &
29212950Sgabeblack@google.comgetTopLevelScObjects()
29312950Sgabeblack@google.com{
29412950Sgabeblack@google.com    return topLevelObjects;
29512950Sgabeblack@google.com}
29612950Sgabeblack@google.com
29712950Sgabeblack@google.comsc_core::sc_object *
29812950Sgabeblack@google.comfindObject(const char *name, const Objects &objects)
29912950Sgabeblack@google.com{
30012950Sgabeblack@google.com    ObjectsIt it = findObjectIn(allObjects, name);
30112950Sgabeblack@google.com    return it == allObjects.end() ? nullptr : *it;
30212950Sgabeblack@google.com}
30312950Sgabeblack@google.com
30413268Sgabeblack@google.comnamespace
30513268Sgabeblack@google.com{
30613268Sgabeblack@google.com
30713268Sgabeblack@google.comstd::stack<sc_core::sc_object *> objParentStack;
30813268Sgabeblack@google.com
30913268Sgabeblack@google.com} // anonymous namespace
31013268Sgabeblack@google.com
31113268Sgabeblack@google.comsc_core::sc_object *
31213268Sgabeblack@google.compickParentObj()
31313268Sgabeblack@google.com{
31413268Sgabeblack@google.com    if (!objParentStack.empty())
31513268Sgabeblack@google.com        return objParentStack.top();
31613268Sgabeblack@google.com
31713268Sgabeblack@google.com    Process *p = scheduler.current();
31813268Sgabeblack@google.com    if (p)
31913268Sgabeblack@google.com        return p;
32013268Sgabeblack@google.com
32113268Sgabeblack@google.com    return nullptr;
32213268Sgabeblack@google.com}
32313268Sgabeblack@google.com
32413268Sgabeblack@google.comvoid pushParentObj(sc_core::sc_object *obj) { objParentStack.push(obj); }
32513268Sgabeblack@google.comvoid popParentObj() { objParentStack.pop(); }
32613268Sgabeblack@google.com
32712950Sgabeblack@google.com} // namespace sc_gem5
328