xref: /gem5/src/systemc/core/sc_port.cc

/*
 * Copyright 2018 Google, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Gabe Black
 */

#include <sstream>

#include "base/cprintf.hh"
#include "systemc/core/module.hh"
#include "systemc/core/port.hh"
#include "systemc/core/scheduler.hh"
#include "systemc/ext/channel/messages.hh"
#include "systemc/ext/core/sc_main.hh"
#include "systemc/ext/core/sc_port.hh"

namespace sc_core
{

namespace
{

void
reportError(const char *id, const char *add_msg,
        const char *name, const char *kind)
{
    std::string msg;
    if (add_msg)
        msg = csprintf("%s: port '%s' (%s)", add_msg, name, kind);
    else
        msg = csprintf("port '%s' (%s)", name, kind);

    SC_REPORT_ERROR(id, msg.c_str());
}

}

sc_port_base::sc_port_base(const char *n, int max_size, sc_port_policy p) :
    sc_object(n), _gem5Port(nullptr)
{
    if (sc_is_running()) {
        reportError(SC_ID_INSERT_PORT_, "simulation running",
                name(), kind());
    }
    if (::sc_gem5::scheduler.elaborationDone()) {
        reportError(SC_ID_INSERT_PORT_, "elaboration done",
                name(), kind());
    }

    auto m = sc_gem5::pickParentModule();
    if (!m)
        reportError(SC_ID_PORT_OUTSIDE_MODULE_, nullptr, name(), kind());
    else
        m->ports.push_back(this);
    _gem5Port = new ::sc_gem5::Port(this, max_size);
}

sc_port_base::~sc_port_base()
{
    delete _gem5Port;
}

void
sc_port_base::warn_port_constructor() const
{
    static bool warned = false;
    if (!warned) {
        SC_REPORT_INFO(SC_ID_IEEE_1666_DEPRECATION_,
                "interface and/or port binding in port constructors "
                "is deprecated");
        warned = true;
    }
}

void
sc_port_base::report_error(const char *id, const char *add_msg) const
{
    std::ostringstream ss;
    if (add_msg)
        ss << add_msg << ": ";
    ss << "port '" << name() << "' (" << kind() << ")";
    SC_REPORT_ERROR(id, ss.str().c_str());
}

int sc_port_base::maxSize() const { return _gem5Port->maxSize(); }
int sc_port_base::size() const { return _gem5Port->size(); }

void sc_port_base::bind(sc_interface &i) { _gem5Port->bind(&i); }
void sc_port_base::bind(sc_port_base &p) { _gem5Port->bind(&p); }

} // namespace sc_core