sc_export.hh revision 13246:b2648bba3d91 
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_EXPORT_HH__
31#define __SYSTEMC_EXT_CORE_SC_EXPORT_HH__
32
33#include "../utils/sc_report_handler.hh"
34#include "sc_module.hh" // for sc_gen_unique_name
35#include "sc_object.hh"
36
37namespace sc_core
38{
39
40class sc_interface;
41
42class sc_export_base : public sc_object
43{
44  public:
45    sc_export_base(const char *n);
46    ~sc_export_base();
47
48    virtual sc_interface *get_iterface() = 0;
49    virtual const sc_interface *get_interface() const = 0;
50
51  protected:
52    friend class sc_gem5::Module;
53
54    virtual void before_end_of_elaboration() = 0;
55    virtual void end_of_elaboration() = 0;
56    virtual void start_of_simulation() = 0;
57    virtual void end_of_simulation() = 0;
58};
59
60template <class IF>
61class sc_export : public sc_export_base
62{
63  public:
64    sc_export() :
65        sc_export_base(sc_gen_unique_name("export")), interface(nullptr)
66    {}
67    explicit sc_export(const char *n) :
68        sc_export_base(n), interface(nullptr)
69    {}
70    virtual ~sc_export() {}
71
72    virtual const char *kind() const { return "sc_export"; }
73
74    void operator () (IF &i) { bind(i); }
75    virtual void
76    bind(IF &i)
77    {
78        if (interface) {
79            SC_REPORT_ERROR("(E126) sc_export instance already bound", name());
80            return;
81        }
82        interface = &i;
83    }
84    operator IF & ()
85    {
86        if (!interface) {
87            SC_REPORT_ERROR("(E120) sc_export instance has no interface",
88                    name());
89        }
90        return *interface;
91    }
92    operator const IF & () const { return *interface; }
93
94    IF *
95    operator -> ()
96    {
97        if (!interface) {
98            SC_REPORT_ERROR("(E120) sc_export instance has no interface",
99                    name());
100        }
101        return interface;
102    }
103    const IF *
104    operator -> () const
105    {
106        if (!interface) {
107            SC_REPORT_ERROR("(E120) sc_export instance has no interface",
108                    name());
109        }
110        return interface;
111    }
112
113    sc_interface *get_iterface() override { return interface; }
114    const sc_interface *get_interface() const override { return interface; }
115
116  protected:
117    void before_end_of_elaboration() {}
118    void
119    end_of_elaboration()
120    {
121        if (!interface) {
122            std::string msg = "export not bound: export '";
123            msg = msg + name() + "' (" + kind() + ")";
124            SC_REPORT_ERROR("(E109) complete binding failed", msg.c_str());
125        }
126    }
127    void start_of_simulation() {}
128    void end_of_simulation() {}
129
130  private:
131    IF *interface;
132
133    // Disabled
134    sc_export(const sc_export<IF> &);
135    sc_export<IF> &operator = (const sc_export<IF> &);
136};
137
138} // namespace sc_core
139
140#endif  //__SYSTEMC_EXT_CORE_SC_EXPORT_HH__
141