112837Sgabeblack@google.com/* 212837Sgabeblack@google.com * Copyright 2018 Google, Inc. 312837Sgabeblack@google.com * 412837Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512837Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612837Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812837Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012837Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112837Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212837Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312837Sgabeblack@google.com * this software without specific prior written permission. 1412837Sgabeblack@google.com * 1512837Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612837Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712837Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812837Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912837Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012837Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112837Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212837Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312837Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412837Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512837Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612837Sgabeblack@google.com * 2712837Sgabeblack@google.com * Authors: Gabe Black 2812837Sgabeblack@google.com */ 2912837Sgabeblack@google.com 3012837Sgabeblack@google.com#ifndef __SYSTEMC_EXT_CORE_SC_EXPORT_HH__ 3112837Sgabeblack@google.com#define __SYSTEMC_EXT_CORE_SC_EXPORT_HH__ 3212837Sgabeblack@google.com 3313324Sgabeblack@google.com#include "../channel/messages.hh" 3413246Sgabeblack@google.com#include "../utils/sc_report_handler.hh" 3513048Sgabeblack@google.com#include "sc_module.hh" // for sc_gen_unique_name 3612837Sgabeblack@google.com#include "sc_object.hh" 3712837Sgabeblack@google.com 3812837Sgabeblack@google.comnamespace sc_core 3912837Sgabeblack@google.com{ 4012837Sgabeblack@google.com 4112837Sgabeblack@google.comclass sc_interface; 4212837Sgabeblack@google.com 4312837Sgabeblack@google.comclass sc_export_base : public sc_object 4412837Sgabeblack@google.com{ 4512837Sgabeblack@google.com public: 4613048Sgabeblack@google.com sc_export_base(const char *n); 4713048Sgabeblack@google.com ~sc_export_base(); 4812992Sgabeblack@google.com 4912992Sgabeblack@google.com virtual sc_interface *get_iterface() = 0; 5012992Sgabeblack@google.com virtual const sc_interface *get_interface() const = 0; 5113059Sgabeblack@google.com 5213059Sgabeblack@google.com protected: 5313191Sgabeblack@google.com friend class sc_gem5::Module; 5413059Sgabeblack@google.com 5513059Sgabeblack@google.com virtual void before_end_of_elaboration() = 0; 5613059Sgabeblack@google.com virtual void end_of_elaboration() = 0; 5713059Sgabeblack@google.com virtual void start_of_simulation() = 0; 5813059Sgabeblack@google.com virtual void end_of_simulation() = 0; 5912837Sgabeblack@google.com}; 6012837Sgabeblack@google.com 6112837Sgabeblack@google.comtemplate <class IF> 6212837Sgabeblack@google.comclass sc_export : public sc_export_base 6312837Sgabeblack@google.com{ 6412837Sgabeblack@google.com public: 6513048Sgabeblack@google.com sc_export() : 6613048Sgabeblack@google.com sc_export_base(sc_gen_unique_name("export")), interface(nullptr) 6713048Sgabeblack@google.com {} 6813048Sgabeblack@google.com explicit sc_export(const char *n) : 6913048Sgabeblack@google.com sc_export_base(n), interface(nullptr) 7013048Sgabeblack@google.com {} 7113048Sgabeblack@google.com virtual ~sc_export() {} 7212837Sgabeblack@google.com 7312837Sgabeblack@google.com virtual const char *kind() const { return "sc_export"; } 7412837Sgabeblack@google.com 7513048Sgabeblack@google.com void operator () (IF &i) { bind(i); } 7613246Sgabeblack@google.com virtual void 7713246Sgabeblack@google.com bind(IF &i) 7813246Sgabeblack@google.com { 7913246Sgabeblack@google.com if (interface) { 8013324Sgabeblack@google.com SC_REPORT_ERROR(SC_ID_SC_EXPORT_ALREADY_BOUND_, name()); 8113246Sgabeblack@google.com return; 8213246Sgabeblack@google.com } 8313246Sgabeblack@google.com interface = &i; 8413246Sgabeblack@google.com } 8513246Sgabeblack@google.com operator IF & () 8613246Sgabeblack@google.com { 8713324Sgabeblack@google.com if (!interface) 8813324Sgabeblack@google.com SC_REPORT_ERROR(SC_ID_SC_EXPORT_HAS_NO_INTERFACE_, name()); 8913246Sgabeblack@google.com return *interface; 9013246Sgabeblack@google.com } 9113048Sgabeblack@google.com operator const IF & () const { return *interface; } 9212837Sgabeblack@google.com 9313246Sgabeblack@google.com IF * 9413246Sgabeblack@google.com operator -> () 9513246Sgabeblack@google.com { 9613324Sgabeblack@google.com if (!interface) 9713324Sgabeblack@google.com SC_REPORT_ERROR(SC_ID_SC_EXPORT_HAS_NO_INTERFACE_, name()); 9813246Sgabeblack@google.com return interface; 9913246Sgabeblack@google.com } 10013246Sgabeblack@google.com const IF * 10113246Sgabeblack@google.com operator -> () const 10213246Sgabeblack@google.com { 10313324Sgabeblack@google.com if (!interface) 10413324Sgabeblack@google.com SC_REPORT_ERROR(SC_ID_SC_EXPORT_HAS_NO_INTERFACE_, name()); 10513246Sgabeblack@google.com return interface; 10613246Sgabeblack@google.com } 10712837Sgabeblack@google.com 10813048Sgabeblack@google.com sc_interface *get_iterface() override { return interface; } 10913048Sgabeblack@google.com const sc_interface *get_interface() const override { return interface; } 11012837Sgabeblack@google.com 11112837Sgabeblack@google.com protected: 11213059Sgabeblack@google.com void before_end_of_elaboration() {} 11313246Sgabeblack@google.com void 11413246Sgabeblack@google.com end_of_elaboration() 11513246Sgabeblack@google.com { 11613246Sgabeblack@google.com if (!interface) { 11713246Sgabeblack@google.com std::string msg = "export not bound: export '"; 11813246Sgabeblack@google.com msg = msg + name() + "' (" + kind() + ")"; 11913246Sgabeblack@google.com SC_REPORT_ERROR("(E109) complete binding failed", msg.c_str()); 12013246Sgabeblack@google.com } 12113246Sgabeblack@google.com } 12213059Sgabeblack@google.com void start_of_simulation() {} 12313059Sgabeblack@google.com void end_of_simulation() {} 12412837Sgabeblack@google.com 12512837Sgabeblack@google.com private: 12613048Sgabeblack@google.com IF *interface; 12713048Sgabeblack@google.com 12812837Sgabeblack@google.com // Disabled 12912837Sgabeblack@google.com sc_export(const sc_export<IF> &); 13012837Sgabeblack@google.com sc_export<IF> &operator = (const sc_export<IF> &); 13112837Sgabeblack@google.com}; 13212837Sgabeblack@google.com 13312837Sgabeblack@google.com} // namespace sc_core 13412837Sgabeblack@google.com 13512837Sgabeblack@google.com#endif //__SYSTEMC_EXT_CORE_SC_EXPORT_HH__ 136