sc_export.h revision 12027
112027Sjungma@eit.uni-kl.de/***************************************************************************** 212027Sjungma@eit.uni-kl.de 312027Sjungma@eit.uni-kl.de Licensed to Accellera Systems Initiative Inc. (Accellera) under one or 412027Sjungma@eit.uni-kl.de more contributor license agreements. See the NOTICE file distributed 512027Sjungma@eit.uni-kl.de with this work for additional information regarding copyright ownership. 612027Sjungma@eit.uni-kl.de Accellera licenses this file to you under the Apache License, Version 2.0 712027Sjungma@eit.uni-kl.de (the "License"); you may not use this file except in compliance with the 812027Sjungma@eit.uni-kl.de License. You may obtain a copy of the License at 912027Sjungma@eit.uni-kl.de 1012027Sjungma@eit.uni-kl.de http://www.apache.org/licenses/LICENSE-2.0 1112027Sjungma@eit.uni-kl.de 1212027Sjungma@eit.uni-kl.de Unless required by applicable law or agreed to in writing, software 1312027Sjungma@eit.uni-kl.de distributed under the License is distributed on an "AS IS" BASIS, 1412027Sjungma@eit.uni-kl.de WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 1512027Sjungma@eit.uni-kl.de implied. See the License for the specific language governing 1612027Sjungma@eit.uni-kl.de permissions and limitations under the License. 1712027Sjungma@eit.uni-kl.de 1812027Sjungma@eit.uni-kl.de *****************************************************************************/ 1912027Sjungma@eit.uni-kl.de 2012027Sjungma@eit.uni-kl.de/***************************************************************************** 2112027Sjungma@eit.uni-kl.de 2212027Sjungma@eit.uni-kl.de sc_export.h -- Base classes of all export classes. 2312027Sjungma@eit.uni-kl.de 2412027Sjungma@eit.uni-kl.de Original Author: Andy Goodrich, Forte Design Systems 2512027Sjungma@eit.uni-kl.de Bishnupriya Bhattacharya, Cadence Design Systems 2612027Sjungma@eit.uni-kl.de 2712027Sjungma@eit.uni-kl.de CHANGE LOG IS AT THE END OF THE FILE 2812027Sjungma@eit.uni-kl.de *****************************************************************************/ 2912027Sjungma@eit.uni-kl.de 3012027Sjungma@eit.uni-kl.de#ifndef SC_EXPORT_H 3112027Sjungma@eit.uni-kl.de#define SC_EXPORT_H 3212027Sjungma@eit.uni-kl.de#include <typeinfo> 3312027Sjungma@eit.uni-kl.de 3412027Sjungma@eit.uni-kl.de#include "sysc/communication/sc_communication_ids.h" 3512027Sjungma@eit.uni-kl.de#include "sysc/communication/sc_interface.h" 3612027Sjungma@eit.uni-kl.de#include "sysc/kernel/sc_object.h" 3712027Sjungma@eit.uni-kl.de 3812027Sjungma@eit.uni-kl.de#if ! defined( SC_DISABLE_VIRTUAL_BIND ) 3912027Sjungma@eit.uni-kl.de# define SC_VIRTUAL_ virtual 4012027Sjungma@eit.uni-kl.de#else 4112027Sjungma@eit.uni-kl.de# define SC_VIRTUAL_ /* non-virtual */ 4212027Sjungma@eit.uni-kl.de#endif 4312027Sjungma@eit.uni-kl.de 4412027Sjungma@eit.uni-kl.denamespace sc_core { 4512027Sjungma@eit.uni-kl.de 4612027Sjungma@eit.uni-kl.de//============================================================================= 4712027Sjungma@eit.uni-kl.de// CLASS : sc_export_base 4812027Sjungma@eit.uni-kl.de// 4912027Sjungma@eit.uni-kl.de// Abstract base class for class sc_export<IF>. 5012027Sjungma@eit.uni-kl.de//============================================================================= 5112027Sjungma@eit.uni-kl.de 5212027Sjungma@eit.uni-kl.declass sc_export_base : public sc_object 5312027Sjungma@eit.uni-kl.de{ 5412027Sjungma@eit.uni-kl.de friend class sc_export_registry; 5512027Sjungma@eit.uni-kl.depublic: 5612027Sjungma@eit.uni-kl.de 5712027Sjungma@eit.uni-kl.de // typedefs 5812027Sjungma@eit.uni-kl.de 5912027Sjungma@eit.uni-kl.de typedef sc_export_base this_type; 6012027Sjungma@eit.uni-kl.de 6112027Sjungma@eit.uni-kl.depublic: 6212027Sjungma@eit.uni-kl.de 6312027Sjungma@eit.uni-kl.de virtual sc_interface* get_interface() = 0; 6412027Sjungma@eit.uni-kl.de virtual const sc_interface* get_interface() const = 0; 6512027Sjungma@eit.uni-kl.de 6612027Sjungma@eit.uni-kl.deprotected: 6712027Sjungma@eit.uni-kl.de 6812027Sjungma@eit.uni-kl.de // constructors 6912027Sjungma@eit.uni-kl.de 7012027Sjungma@eit.uni-kl.de sc_export_base(); 7112027Sjungma@eit.uni-kl.de sc_export_base(const char* name); 7212027Sjungma@eit.uni-kl.de 7312027Sjungma@eit.uni-kl.de // destructor 7412027Sjungma@eit.uni-kl.de 7512027Sjungma@eit.uni-kl.de virtual ~sc_export_base(); 7612027Sjungma@eit.uni-kl.de 7712027Sjungma@eit.uni-kl.deprotected: 7812027Sjungma@eit.uni-kl.de 7912027Sjungma@eit.uni-kl.de // called when construction is done 8012027Sjungma@eit.uni-kl.de virtual void before_end_of_elaboration(); 8112027Sjungma@eit.uni-kl.de 8212027Sjungma@eit.uni-kl.de // called when elaboration is done (does nothing by default) 8312027Sjungma@eit.uni-kl.de virtual void end_of_elaboration(); 8412027Sjungma@eit.uni-kl.de 8512027Sjungma@eit.uni-kl.de // called before simulation starts (does nothing by default) 8612027Sjungma@eit.uni-kl.de virtual void start_of_simulation(); 8712027Sjungma@eit.uni-kl.de 8812027Sjungma@eit.uni-kl.de // called after simulation ends (does nothing) 8912027Sjungma@eit.uni-kl.de virtual void end_of_simulation(); 9012027Sjungma@eit.uni-kl.de 9112027Sjungma@eit.uni-kl.de virtual const char* if_typename() const = 0; 9212027Sjungma@eit.uni-kl.de 9312027Sjungma@eit.uni-kl.de // error reporting 9412027Sjungma@eit.uni-kl.de void report_error( const char* id, const char* add_msg = 0) const; 9512027Sjungma@eit.uni-kl.de 9612027Sjungma@eit.uni-kl.deprivate: 9712027Sjungma@eit.uni-kl.de 9812027Sjungma@eit.uni-kl.de void construction_done(); 9912027Sjungma@eit.uni-kl.de void elaboration_done(); 10012027Sjungma@eit.uni-kl.de void start_simulation(); 10112027Sjungma@eit.uni-kl.de void simulation_done(); 10212027Sjungma@eit.uni-kl.de 10312027Sjungma@eit.uni-kl.de // disabled 10412027Sjungma@eit.uni-kl.de sc_export_base(const this_type&); 10512027Sjungma@eit.uni-kl.de this_type& operator = (const this_type& ); 10612027Sjungma@eit.uni-kl.de 10712027Sjungma@eit.uni-kl.de}; 10812027Sjungma@eit.uni-kl.de 10912027Sjungma@eit.uni-kl.de//============================================================================= 11012027Sjungma@eit.uni-kl.de// CLASS : sc_export 11112027Sjungma@eit.uni-kl.de// 11212027Sjungma@eit.uni-kl.de// Generic export class for other export classes. This 11312027Sjungma@eit.uni-kl.de// class provides a binding point for access to an interface. 11412027Sjungma@eit.uni-kl.de//============================================================================= 11512027Sjungma@eit.uni-kl.detemplate<class IF> 11612027Sjungma@eit.uni-kl.declass sc_export : public sc_export_base 11712027Sjungma@eit.uni-kl.de{ 11812027Sjungma@eit.uni-kl.de typedef sc_export<IF> this_type; 11912027Sjungma@eit.uni-kl.de 12012027Sjungma@eit.uni-kl.depublic: // constructors: 12112027Sjungma@eit.uni-kl.de sc_export() : sc_export_base() 12212027Sjungma@eit.uni-kl.de { 12312027Sjungma@eit.uni-kl.de m_interface_p = 0; 12412027Sjungma@eit.uni-kl.de } 12512027Sjungma@eit.uni-kl.de 12612027Sjungma@eit.uni-kl.de explicit sc_export( const char* name_ ) : sc_export_base(name_) 12712027Sjungma@eit.uni-kl.de { 12812027Sjungma@eit.uni-kl.de m_interface_p = 0; 12912027Sjungma@eit.uni-kl.de } 13012027Sjungma@eit.uni-kl.de 13112027Sjungma@eit.uni-kl.depublic: // destructor: 13212027Sjungma@eit.uni-kl.de virtual ~sc_export() 13312027Sjungma@eit.uni-kl.de { 13412027Sjungma@eit.uni-kl.de } 13512027Sjungma@eit.uni-kl.de 13612027Sjungma@eit.uni-kl.depublic: // interface access: 13712027Sjungma@eit.uni-kl.de 13812027Sjungma@eit.uni-kl.de virtual sc_interface* get_interface() 13912027Sjungma@eit.uni-kl.de { 14012027Sjungma@eit.uni-kl.de return m_interface_p; 14112027Sjungma@eit.uni-kl.de } 14212027Sjungma@eit.uni-kl.de 14312027Sjungma@eit.uni-kl.de virtual const sc_interface* get_interface() const 14412027Sjungma@eit.uni-kl.de { 14512027Sjungma@eit.uni-kl.de return m_interface_p; 14612027Sjungma@eit.uni-kl.de } 14712027Sjungma@eit.uni-kl.de 14812027Sjungma@eit.uni-kl.de const IF* operator -> () const { 14912027Sjungma@eit.uni-kl.de if ( m_interface_p == 0 ) 15012027Sjungma@eit.uni-kl.de { 15112027Sjungma@eit.uni-kl.de SC_REPORT_ERROR(SC_ID_SC_EXPORT_HAS_NO_INTERFACE_,name()); 15212027Sjungma@eit.uni-kl.de } 15312027Sjungma@eit.uni-kl.de return m_interface_p; 15412027Sjungma@eit.uni-kl.de } 15512027Sjungma@eit.uni-kl.de 15612027Sjungma@eit.uni-kl.de IF* operator -> () { 15712027Sjungma@eit.uni-kl.de if ( m_interface_p == 0 ) 15812027Sjungma@eit.uni-kl.de { 15912027Sjungma@eit.uni-kl.de SC_REPORT_ERROR(SC_ID_SC_EXPORT_HAS_NO_INTERFACE_,name()); 16012027Sjungma@eit.uni-kl.de } 16112027Sjungma@eit.uni-kl.de return m_interface_p; 16212027Sjungma@eit.uni-kl.de } 16312027Sjungma@eit.uni-kl.de 16412027Sjungma@eit.uni-kl.de operator IF& () 16512027Sjungma@eit.uni-kl.de { 16612027Sjungma@eit.uni-kl.de if ( m_interface_p == 0 ) 16712027Sjungma@eit.uni-kl.de { 16812027Sjungma@eit.uni-kl.de SC_REPORT_ERROR(SC_ID_SC_EXPORT_HAS_NO_INTERFACE_,name()); 16912027Sjungma@eit.uni-kl.de } 17012027Sjungma@eit.uni-kl.de return *m_interface_p; 17112027Sjungma@eit.uni-kl.de } 17212027Sjungma@eit.uni-kl.de operator const IF&() const 17312027Sjungma@eit.uni-kl.de { return *const_cast<this_type*>(this); } 17412027Sjungma@eit.uni-kl.de 17512027Sjungma@eit.uni-kl.de 17612027Sjungma@eit.uni-kl.depublic: // binding: 17712027Sjungma@eit.uni-kl.de SC_VIRTUAL_ void bind( IF& interface_ ) 17812027Sjungma@eit.uni-kl.de { 17912027Sjungma@eit.uni-kl.de if ( m_interface_p ) 18012027Sjungma@eit.uni-kl.de { 18112027Sjungma@eit.uni-kl.de SC_REPORT_ERROR(SC_ID_SC_EXPORT_ALREADY_BOUND_,name()); 18212027Sjungma@eit.uni-kl.de } 18312027Sjungma@eit.uni-kl.de else 18412027Sjungma@eit.uni-kl.de { 18512027Sjungma@eit.uni-kl.de m_interface_p = &interface_; 18612027Sjungma@eit.uni-kl.de } 18712027Sjungma@eit.uni-kl.de } 18812027Sjungma@eit.uni-kl.de 18912027Sjungma@eit.uni-kl.de void operator () ( IF& interface_ ) 19012027Sjungma@eit.uni-kl.de { 19112027Sjungma@eit.uni-kl.de this->bind(interface_); 19212027Sjungma@eit.uni-kl.de } 19312027Sjungma@eit.uni-kl.de 19412027Sjungma@eit.uni-kl.depublic: // identification: 19512027Sjungma@eit.uni-kl.de virtual const char* kind() const { return "sc_export"; } 19612027Sjungma@eit.uni-kl.de 19712027Sjungma@eit.uni-kl.deprotected: 19812027Sjungma@eit.uni-kl.de const char* if_typename() const { 19912027Sjungma@eit.uni-kl.de return typeid( IF ).name(); 20012027Sjungma@eit.uni-kl.de } 20112027Sjungma@eit.uni-kl.de 20212027Sjungma@eit.uni-kl.deprivate: // disabled 20312027Sjungma@eit.uni-kl.de sc_export( const this_type& ); 20412027Sjungma@eit.uni-kl.de this_type& operator = ( const this_type& ); 20512027Sjungma@eit.uni-kl.de 20612027Sjungma@eit.uni-kl.deprotected: // data fields: 20712027Sjungma@eit.uni-kl.de IF* m_interface_p; // Interface this port provides. 20812027Sjungma@eit.uni-kl.de}; 20912027Sjungma@eit.uni-kl.de 21012027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 21112027Sjungma@eit.uni-kl.de// CLASS : sc_export_registry 21212027Sjungma@eit.uni-kl.de// 21312027Sjungma@eit.uni-kl.de// Registry for all exports. 21412027Sjungma@eit.uni-kl.de// FOR INTERNAL USE ONLY! 21512027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 21612027Sjungma@eit.uni-kl.de 21712027Sjungma@eit.uni-kl.declass sc_export_registry 21812027Sjungma@eit.uni-kl.de{ 21912027Sjungma@eit.uni-kl.de friend class sc_simcontext; 22012027Sjungma@eit.uni-kl.de 22112027Sjungma@eit.uni-kl.depublic: 22212027Sjungma@eit.uni-kl.de 22312027Sjungma@eit.uni-kl.de void insert( sc_export_base* ); 22412027Sjungma@eit.uni-kl.de void remove( sc_export_base* ); 22512027Sjungma@eit.uni-kl.de 22612027Sjungma@eit.uni-kl.de int size() const 22712027Sjungma@eit.uni-kl.de { return m_export_vec.size(); } 22812027Sjungma@eit.uni-kl.de 22912027Sjungma@eit.uni-kl.deprivate: 23012027Sjungma@eit.uni-kl.de 23112027Sjungma@eit.uni-kl.de // constructor 23212027Sjungma@eit.uni-kl.de explicit sc_export_registry( sc_simcontext& simc_ ); 23312027Sjungma@eit.uni-kl.de 23412027Sjungma@eit.uni-kl.de // destructor 23512027Sjungma@eit.uni-kl.de ~sc_export_registry(); 23612027Sjungma@eit.uni-kl.de 23712027Sjungma@eit.uni-kl.de // called when construction is done 23812027Sjungma@eit.uni-kl.de bool construction_done(); 23912027Sjungma@eit.uni-kl.de 24012027Sjungma@eit.uni-kl.de // called when elaboration is done 24112027Sjungma@eit.uni-kl.de void elaboration_done(); 24212027Sjungma@eit.uni-kl.de 24312027Sjungma@eit.uni-kl.de // called before simulation starts 24412027Sjungma@eit.uni-kl.de void start_simulation(); 24512027Sjungma@eit.uni-kl.de 24612027Sjungma@eit.uni-kl.de // called after simulation ends 24712027Sjungma@eit.uni-kl.de void simulation_done(); 24812027Sjungma@eit.uni-kl.de 24912027Sjungma@eit.uni-kl.deprivate: 25012027Sjungma@eit.uni-kl.de 25112027Sjungma@eit.uni-kl.de int m_construction_done; 25212027Sjungma@eit.uni-kl.de std::vector<sc_export_base*> m_export_vec; 25312027Sjungma@eit.uni-kl.de sc_simcontext* m_simc; 25412027Sjungma@eit.uni-kl.de 25512027Sjungma@eit.uni-kl.deprivate: 25612027Sjungma@eit.uni-kl.de 25712027Sjungma@eit.uni-kl.de // disabled 25812027Sjungma@eit.uni-kl.de sc_export_registry(); 25912027Sjungma@eit.uni-kl.de sc_export_registry( const sc_export_registry& ); 26012027Sjungma@eit.uni-kl.de sc_export_registry& operator = ( const sc_export_registry& ); 26112027Sjungma@eit.uni-kl.de}; 26212027Sjungma@eit.uni-kl.de 26312027Sjungma@eit.uni-kl.de} // namespace sc_core 26412027Sjungma@eit.uni-kl.de 26512027Sjungma@eit.uni-kl.de#undef SC_VIRTUAL_ 26612027Sjungma@eit.uni-kl.de 26712027Sjungma@eit.uni-kl.de// $Log: sc_export.h,v $ 26812027Sjungma@eit.uni-kl.de// Revision 1.7 2011/08/26 20:45:40 acg 26912027Sjungma@eit.uni-kl.de// Andy Goodrich: moved the modification log to the end of the file to 27012027Sjungma@eit.uni-kl.de// eliminate source line number skew when check-ins are done. 27112027Sjungma@eit.uni-kl.de// 27212027Sjungma@eit.uni-kl.de// Revision 1.6 2011/05/09 04:07:37 acg 27312027Sjungma@eit.uni-kl.de// Philipp A. Hartmann: 27412027Sjungma@eit.uni-kl.de// (1) Restore hierarchy in all phase callbacks. 27512027Sjungma@eit.uni-kl.de// (2) Ensure calls to before_end_of_elaboration. 27612027Sjungma@eit.uni-kl.de// 27712027Sjungma@eit.uni-kl.de// Revision 1.5 2011/04/02 00:02:14 acg 27812027Sjungma@eit.uni-kl.de// Philipp A. Hartmann: add const overload for sc_export::operator IF& 27912027Sjungma@eit.uni-kl.de// 28012027Sjungma@eit.uni-kl.de// Revision 1.4 2011/02/18 20:23:45 acg 28112027Sjungma@eit.uni-kl.de// Andy Goodrich: Copyright update. 28212027Sjungma@eit.uni-kl.de// 28312027Sjungma@eit.uni-kl.de// Revision 1.3 2011/02/14 17:50:16 acg 28412027Sjungma@eit.uni-kl.de// Andy Goodrich: testing for sc_port and sc_export instantiations during 28512027Sjungma@eit.uni-kl.de// end of elaboration and issuing appropriate error messages. 28612027Sjungma@eit.uni-kl.de// 28712027Sjungma@eit.uni-kl.de// Revision 1.2 2011/01/20 16:52:15 acg 28812027Sjungma@eit.uni-kl.de// Andy Goodrich: changes for IEEE 1666 2011. 28912027Sjungma@eit.uni-kl.de// 29012027Sjungma@eit.uni-kl.de// Revision 1.1.1.1 2006/12/15 20:20:04 acg 29112027Sjungma@eit.uni-kl.de// SystemC 2.3 29212027Sjungma@eit.uni-kl.de// 29312027Sjungma@eit.uni-kl.de// Revision 1.3 2006/01/13 18:47:42 acg 29412027Sjungma@eit.uni-kl.de// Added $Log command so that CVS comments are reproduced in the source. 29512027Sjungma@eit.uni-kl.de// 29612027Sjungma@eit.uni-kl.de 29712027Sjungma@eit.uni-kl.de#endif 29812027Sjungma@eit.uni-kl.de 29912027Sjungma@eit.uni-kl.de// Taf! 300