sc_port.hh revision 13132:1fb4a87f550f 
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#ifndef __SYSTEMC_EXT_CORE_SC_PORT_HH__
31#define __SYSTEMC_EXT_CORE_SC_PORT_HH__
32
33#include <vector>
34
35#include "../utils/sc_report_handler.hh"
36#include "sc_module.hh" // for sc_gen_unique_name
37#include "sc_object.hh"
38
39namespace sc_gem5
40{
41
42class BindInfo;
43class Module;
44class PendingSensitivityPort;
45class PendingSensitivityFinder;
46
47};
48
49namespace sc_core
50{
51
52class sc_interface;
53
54enum sc_port_policy
55{
56    SC_ONE_OR_MORE_BOUND, // Default
57    SC_ZERO_OR_MORE_BOUND,
58    SC_ALL_BOUND
59};
60
61class sc_port_base : public sc_object
62{
63  public:
64    sc_port_base(const char *name, int n, sc_port_policy p);
65
66    void warn_unimpl(const char *func) const;
67
68    int maxSize() const;
69    int size() const;
70
71  protected:
72    // Implementation defined, but depended on by the tests.
73    void bind(sc_interface &);
74    void bind(sc_port_base &);
75
76    friend class ::sc_gem5::Module;
77
78    // Implementation defined, but depended on by the tests.
79    virtual int vbind(sc_interface &) = 0;
80    virtual int vbind(sc_port_base &) = 0;
81
82    virtual void before_end_of_elaboration() = 0;
83    virtual void end_of_elaboration() = 0;
84    virtual void start_of_simulation() = 0;
85    virtual void end_of_simulation() = 0;
86
87  private:
88    friend class ::sc_gem5::PendingSensitivityPort;
89    friend class ::sc_gem5::PendingSensitivityFinder;
90    friend class ::sc_gem5::Kernel;
91
92    void _gem5Finalize();
93
94    virtual sc_interface *_gem5Interface(int n) const = 0;
95    virtual void _gem5AddInterface(sc_interface *i) = 0;
96
97    std::vector<::sc_gem5::BindInfo *> _gem5BindInfo;
98    int _maxSize;
99    int _size;
100    bool finalized;
101};
102
103template <class IF>
104class sc_port_b : public sc_port_base
105{
106  public:
107    void operator () (IF &i) { bind(i); }
108    void operator () (sc_port_b<IF> &p) { bind(p); }
109
110    virtual void bind(IF &i) { sc_port_base::bind(i); }
111    virtual void bind(sc_port_b<IF> &p) { sc_port_base::bind(p); }
112
113    IF *
114    operator -> ()
115    {
116        sc_assert(!_interfaces.empty());
117        return _interfaces[0];
118    }
119    const IF *
120    operator -> () const
121    {
122        sc_assert(!_interfaces.empty());
123        return _interfaces[0];
124    }
125
126    IF *
127    operator [] (int n)
128    {
129        sc_assert(_interfaces.size() > n);
130        return _interfaces[n];
131    }
132    const IF *
133    operator [] (int n) const
134    {
135        sc_assert(_interfaces.size() > n);
136        return _interfaces[n];
137    }
138
139    sc_interface *
140    get_interface()
141    {
142        sc_assert(!_interfaces.empty());
143        return _interfaces[0];
144    }
145    const sc_interface *
146    get_interface() const
147    {
148        sc_assert(!_interfaces.empty());
149        return _interfaces[0];
150    }
151
152  protected:
153    void before_end_of_elaboration() {}
154    void end_of_elaboration() {}
155    void start_of_simulation() {}
156    void end_of_simulation() {}
157
158    explicit sc_port_b(int n, sc_port_policy p) :
159            sc_port_base(sc_gen_unique_name("port"), n, p)
160    {}
161    sc_port_b(const char *name, int n, sc_port_policy p) :
162            sc_port_base(name, n, p)
163    {}
164    virtual ~sc_port_b() {}
165
166    // Implementation defined, but depended on by the tests.
167    int
168    vbind(sc_interface &i)
169    {
170        IF *interface = dynamic_cast<IF *>(&i);
171        if (!interface)
172            return 2;
173        sc_port_base::bind(*interface);
174        return 0;
175    }
176    int
177    vbind(sc_port_base &pb)
178    {
179        sc_port_b<IF> *p = dynamic_cast<sc_port_b<IF> *>(&pb);
180        if (!p)
181            return 2;
182        sc_port_base::bind(*p);
183        return 0;
184    }
185
186  private:
187    std::vector<IF *> _interfaces;
188
189    sc_interface *
190    _gem5Interface(int n) const
191    {
192        sc_assert(_interfaces.size() > n);
193        return _interfaces[n];
194    }
195    void
196    _gem5AddInterface(sc_interface *i)
197    {
198        IF *interface = dynamic_cast<IF *>(i);
199        sc_assert(interface);
200        _interfaces.push_back(interface);
201    }
202
203    // Disabled
204    sc_port_b() {}
205    sc_port_b(const sc_port_b<IF> &) {}
206    sc_port_b<IF> &operator = (const sc_port_b<IF> &) { return *this; }
207};
208
209template <class IF, int N=1, sc_port_policy P=SC_ONE_OR_MORE_BOUND>
210class sc_port : public sc_port_b<IF>
211{
212  public:
213    sc_port() : sc_port_b<IF>(N, P) {}
214    explicit sc_port(const char *name) : sc_port_b<IF>(name, N, P) {}
215    virtual ~sc_port() {}
216
217    // Deprecated binding constructors.
218    explicit sc_port(const IF &interface) : sc_port_b<IF>(N, P)
219    {
220        this->warn_unimpl(__PRETTY_FUNCTION__);
221        // Should warn that these are deprecated. See Accellera sc_port.h.
222        sc_port_b<IF>::bind(const_cast<IF &>(interface));
223    }
224    sc_port(const char *name, const IF &interface) : sc_port_b<IF>(name, N, P)
225    {
226        this->warn_unimpl(__PRETTY_FUNCTION__);
227        // Should warn that these are deprecated. See Accellera sc_port.h.
228        sc_port_b<IF>::bind(const_cast<IF &>(interface));
229    }
230    explicit sc_port(sc_port_b<IF> &parent) : sc_port_b<IF>(N, P)
231    {
232        this->warn_unimpl(__PRETTY_FUNCTION__);
233        // Should warn that these are deprecated. See Accellera sc_port.h.
234        sc_port_b<IF>::bind(parent);
235    }
236    sc_port(const char *name, sc_port_b<IF> &parent) :
237        sc_port_b<IF>(name, N, P)
238    {
239        this->warn_unimpl(__PRETTY_FUNCTION__);
240        // Should warn that these are deprecated. See Accellera sc_port.h.
241        sc_port_b<IF>::bind(parent);
242    }
243    explicit sc_port(sc_port<IF, N, P> &parent) : sc_port_b<IF>(N, P)
244    {
245        this->warn_unimpl(__PRETTY_FUNCTION__);
246        // Should warn that these are deprecated. See Accellera sc_port.h.
247        sc_port_b<IF>::bind(parent);
248    }
249    sc_port(const char *name, sc_port<IF, N, P> &parent) :
250        sc_port_b<IF>(name, N, P)
251    {
252        this->warn_unimpl(__PRETTY_FUNCTION__);
253        // Should warn that these are deprecated. See Accellera sc_port.h.
254        sc_port_b<IF>::bind(parent);
255    }
256
257    virtual const char *kind() const { return "sc_port"; }
258
259  private:
260    // Disabled
261    sc_port(const sc_port<IF, N, P> &) {}
262    sc_port<IF, N, P> &operator = (const sc_port<IF, N, P> &) { return *this; }
263};
264
265} // namespace sc_core
266
267#endif  //__SYSTEMC_EXT_CORE_SC_PORT_HH__
268