src/systemc/ext/core/sc_export.hh

   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 "sc_module.hh" // for sc_gen_unique_name
  34 #include "sc_object.hh"
  35
  36 namespace sc_core
  37 {
  38
  39 class sc_interface;
  40
  41 class sc_export_base : public sc_object
  42 {
  43   public:
  44     sc_export_base(const char *n);
  45     ~sc_export_base();
  46
  47     virtual sc_interface *get_iterface() = 0;
  48     virtual const sc_interface *get_interface() const = 0;
  49
  50   protected:
  51     friend class sc_gem5::Kernel;
  52
  53     virtual void before_end_of_elaboration() = 0;
  54     virtual void end_of_elaboration() = 0;
  55     virtual void start_of_simulation() = 0;
  56     virtual void end_of_simulation() = 0;
  57 };
  58
  59 template <class IF>
  60 class sc_export : public sc_export_base
  61 {
  62   public:
  63     sc_export() :
  64         sc_export_base(sc_gen_unique_name("export")), interface(nullptr)
  65     {}
  66     explicit sc_export(const char *n) :
  67         sc_export_base(n), interface(nullptr)
  68     {}
  69     virtual ~sc_export() {}
  70
  71     virtual const char *kind() const { return "sc_export"; }
  72
  73     void operator () (IF &i) { bind(i); }
  74     virtual void bind(IF &i) { interface = &i; }
  75     operator IF & () { return *interface; }
  76     operator const IF & () const { return *interface; }
  77
  78     IF *operator -> () { return interface; }
  79     const IF *operator -> () const { return interface; }
  80
  81     sc_interface *get_iterface() override { return interface; }
  82     const sc_interface *get_interface() const override { return interface; }
  83
  84   protected:
  85     void before_end_of_elaboration() {}
  86     void end_of_elaboration() {}
  87     void start_of_simulation() {}
  88     void end_of_simulation() {}
  89
  90   private:
  91     IF *interface;
  92
  93     // Disabled
  94     sc_export(const sc_export<IF> &);
  95     sc_export<IF> &operator = (const sc_export<IF> &);
  96 };
  97
  98 } // namespace sc_core
  99
 100 #endif  //__SYSTEMC_EXT_CORE_SC_EXPORT_HH__