diff options
Diffstat (limited to 'ext/systemc/src/sysc/kernel/sc_object.h')
| -rw-r--r-- | ext/systemc/src/sysc/kernel/sc_object.h | 244 |
1 files changed, 244 insertions, 0 deletions
diff --git a/ext/systemc/src/sysc/kernel/sc_object.h b/ext/systemc/src/sysc/kernel/sc_object.h new file mode 100644 index 000000000..c6e0957a8 --- /dev/null +++ b/ext/systemc/src/sysc/kernel/sc_object.h @@ -0,0 +1,244 @@ +/***************************************************************************** + + Licensed to Accellera Systems Initiative Inc. (Accellera) under one or + more contributor license agreements. See the NOTICE file distributed + with this work for additional information regarding copyright ownership. + Accellera licenses this file to you under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. + + *****************************************************************************/ + +/***************************************************************************** + + sc_object.h -- Abstract base class of all SystemC `simulation' objects. + + Original Author: Stan Y. Liao, Synopsys, Inc. + + CHANGE LOG AT THE END OF THE FILE + *****************************************************************************/ + + +#ifndef SC_OBJECT_H +#define SC_OBJECT_H + + +#include "sysc/utils/sc_iostream.h" +#include "sysc/kernel/sc_attribute.h" + +namespace sc_core { + +class sc_event; +class sc_module; +class sc_phase_callback_registry; +class sc_runnable; +class sc_simcontext; +class sc_trace_file; +class sc_trace_file_base; + +// ---------------------------------------------------------------------------- +// CLASS : sc_object +// +// Abstract base class of all SystemC `simulation' objects. +// ---------------------------------------------------------------------------- + +class sc_object +{ + friend class sc_event; + friend class sc_module; + friend struct sc_invoke_method; + friend class sc_module_dynalloc_list; + friend class sc_object_manager; + friend class sc_phase_callback_registry; + friend class sc_process_b; + friend class sc_runnable; + friend class sc_simcontext; + friend class sc_trace_file_base; + +public: + typedef unsigned phase_cb_mask; + + const char* name() const + { return m_name.c_str(); } + + const char* basename() const; + + virtual void print(::std::ostream& os=::std::cout ) const; + + // dump() is more detailed than print() + virtual void dump(::std::ostream& os=::std::cout ) const; + + virtual void trace( sc_trace_file* tf ) const; + + virtual const char* kind() const { return "sc_object"; } + + sc_simcontext* simcontext() const + { return m_simc; } + + // add attribute + bool add_attribute( sc_attr_base& ); + + // get attribute by name + sc_attr_base* get_attribute( const std::string& name_ ); + const sc_attr_base* get_attribute( const std::string& name_ ) const; + + // remove attribute by name + sc_attr_base* remove_attribute( const std::string& name_ ); + + // remove all attributes + void remove_all_attributes(); + + // get the number of attributes + int num_attributes() const; + + // get the attribute collection + sc_attr_cltn& attr_cltn(); + const sc_attr_cltn& attr_cltn() const; + + virtual const std::vector<sc_event*>& get_child_events() const + { return m_child_events; } + + virtual const std::vector<sc_object*>& get_child_objects() const + { return m_child_objects; } + + sc_object* get_parent() const; + sc_object* get_parent_object() const { return m_parent; } + +protected: + + sc_object(); + sc_object(const char* nm); + + sc_object( const sc_object& ); + sc_object& operator=( const sc_object& ); + + + virtual ~sc_object(); + + virtual void add_child_event( sc_event* event_p ); + virtual void add_child_object( sc_object* object_p ); + virtual bool remove_child_event( sc_event* event_p ); + virtual bool remove_child_object( sc_object* object_p ); + + phase_cb_mask register_simulation_phase_callback( phase_cb_mask ); + phase_cb_mask unregister_simulation_phase_callback( phase_cb_mask ); + + class hierarchy_scope; + +private: + void do_simulation_phase_callback(); + virtual void simulation_phase_callback(); + + void detach(); + virtual void orphan_child_events(); + virtual void orphan_child_objects(); + void sc_object_init(const char* nm); + +private: + + /* Each simulation object is associated with a simulation context */ + mutable sc_attr_cltn* m_attr_cltn_p; // attributes for this object. + std::vector<sc_event*> m_child_events; // list of child events. + std::vector<sc_object*> m_child_objects; // list of child objects. + std::string m_name; // name of this object. + sc_object* m_parent; // parent for this object. + sc_simcontext* m_simc; // simcontext ptr / empty indicator +}; + +inline +sc_object& +sc_object::operator=( sc_object const & ) +{ + // deliberately do nothing + return *this; +} + +// ---------------------------------------------------------------------------- + +extern const char SC_HIERARCHY_CHAR; +extern bool sc_enable_name_checking; + + +inline +sc_object* sc_get_parent( const sc_object* obj_p ) +{ + return obj_p->get_parent_object(); +} + +} // namespace sc_core + +/***************************************************************************** + + MODIFICATION LOG - modifiers, enter your name, affiliation, date and + changes you are making here. + + Name, Affiliation, Date: Andy Goodrich, Forte Design Systems + 5 September 2003 + Description of Modification: - Made creation of attributes structure + conditional on its being used. This eliminates + 100 bytes of storage for each normal sc_object. + + *****************************************************************************/ + +// $Log: sc_object.h,v $ +// Revision 1.13 2011/08/29 18:04:32 acg +// Philipp A. Hartmann: miscellaneous clean ups. +// +// Revision 1.12 2011/08/26 20:46:10 acg +// Andy Goodrich: moved the modification log to the end of the file to +// eliminate source line number skew when check-ins are done. +// +// Revision 1.11 2011/03/06 15:55:11 acg +// Andy Goodrich: Changes for named events. +// +// Revision 1.10 2011/03/05 19:44:20 acg +// Andy Goodrich: changes for object and event naming and structures. +// +// Revision 1.9 2011/03/05 01:39:21 acg +// Andy Goodrich: changes for named events. +// +// Revision 1.8 2011/02/18 20:27:14 acg +// Andy Goodrich: Updated Copyrights. +// +// Revision 1.7 2011/02/13 21:47:37 acg +// Andy Goodrich: update copyright notice. +// +// Revision 1.6 2011/01/25 20:50:37 acg +// Andy Goodrich: changes for IEEE 1666 2011. +// +// Revision 1.5 2011/01/18 20:10:44 acg +// Andy Goodrich: changes for IEEE1666_2011 semantics. +// +// Revision 1.4 2010/07/22 20:02:33 acg +// Andy Goodrich: bug fixes. +// +// Revision 1.3 2009/02/28 00:26:58 acg +// Andy Goodrich: changed boost name space to sc_boost to allow use with +// full boost library applications. +// +// Revision 1.2 2008/05/22 17:06:26 acg +// Andy Goodrich: updated copyright notice to include 2008. +// +// Revision 1.1.1.1 2006/12/15 20:20:05 acg +// SystemC 2.3 +// +// Revision 1.5 2006/04/20 17:08:17 acg +// Andy Goodrich: 3.0 style process changes. +// +// Revision 1.4 2006/04/11 23:13:21 acg +// Andy Goodrich: Changes for reduced reset support that only includes +// sc_cthread, but has preliminary hooks for expanding to method and thread +// processes also. +// +// Revision 1.3 2006/01/13 18:44:30 acg +// Added $Log to record CVS changes into the source. + +#endif // SC_OBJECT_H |