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 <sstream>
31
32#include "base/cprintf.hh"
33#include "systemc/core/module.hh"
34#include "systemc/core/port.hh"
35#include "systemc/core/scheduler.hh"
36#include "systemc/ext/channel/messages.hh"
37#include "systemc/ext/core/sc_main.hh"
38#include "systemc/ext/core/sc_port.hh"
39
40namespace sc_core
41{
42
43namespace
44{
45
46void
47reportError(const char *id, const char *add_msg,
48        const char *name, const char *kind)
49{
50    std::string msg;
51    if (add_msg)
52        msg = csprintf("%s: port '%s' (%s)", add_msg, name, kind);
53    else
54        msg = csprintf("port '%s' (%s)", name, kind);
55
56    SC_REPORT_ERROR(id, msg.c_str());
57}
58
59}
60
61sc_port_base::sc_port_base(const char *n, int max_size, sc_port_policy p) :
62    sc_object(n), _gem5Port(nullptr)
63{
64    if (sc_is_running()) {
65        reportError(SC_ID_INSERT_PORT_, "simulation running",
66                name(), kind());
67    }
68    if (::sc_gem5::scheduler.elaborationDone()) {
69        reportError(SC_ID_INSERT_PORT_, "elaboration done",
70                name(), kind());
71    }
72
73    auto m = sc_gem5::pickParentModule();
74    if (!m)
75        reportError(SC_ID_PORT_OUTSIDE_MODULE_, nullptr, name(), kind());
76    else
77        m->ports.push_back(this);
78    _gem5Port = new ::sc_gem5::Port(this, max_size);
79}
80
81sc_port_base::~sc_port_base()
82{
83    delete _gem5Port;
84}
85
86void
87sc_port_base::warn_port_constructor() const
88{
89    static bool warned = false;
90    if (!warned) {
91        SC_REPORT_INFO(SC_ID_IEEE_1666_DEPRECATION_,
92                "interface and/or port binding in port constructors "
93                "is deprecated");
94        warned = true;
95    }
96}
97
98void
99sc_port_base::report_error(const char *id, const char *add_msg) const
100{
101    std::ostringstream ss;
102    if (add_msg)
103        ss << add_msg << ": ";
104    ss << "port '" << name() << "' (" << kind() << ")";
105    SC_REPORT_ERROR(id, ss.str().c_str());
106}
107
108int sc_port_base::maxSize() const { return _gem5Port->maxSize(); }
109int sc_port_base::size() const { return _gem5Port->size(); }
110
111void sc_port_base::bind(sc_interface &i) { _gem5Port->bind(&i); }
112void sc_port_base::bind(sc_port_base &p) { _gem5Port->bind(&p); }
113
114} // namespace sc_core
115