sc_module.hh revision 12930
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_CORE_EXT_SC_MODULE_HH__ 3112837Sgabeblack@google.com#define __SYSTEMC_CORE_EXT_SC_MODULE_HH__ 3212837Sgabeblack@google.com 3312837Sgabeblack@google.com#include <vector> 3412837Sgabeblack@google.com 3512837Sgabeblack@google.com#include "sc_object.hh" 3612837Sgabeblack@google.com#include "sc_sensitive.hh" 3712837Sgabeblack@google.com#include "sc_time.hh" 3812837Sgabeblack@google.com 3912914Sgabeblack@google.comnamespace sc_dt 4012914Sgabeblack@google.com{ 4112914Sgabeblack@google.com 4212914Sgabeblack@google.comclass sc_logic; 4312914Sgabeblack@google.com 4412914Sgabeblack@google.com} // namespace sc_dt 4512914Sgabeblack@google.com 4612837Sgabeblack@google.comnamespace sc_core 4712837Sgabeblack@google.com{ 4812837Sgabeblack@google.com 4912837Sgabeblack@google.comtemplate <class T> 5012837Sgabeblack@google.comclass sc_in; 5112837Sgabeblack@google.comtemplate <class T> 5212837Sgabeblack@google.comclass sc_out; 5312837Sgabeblack@google.comtemplate <class T> 5412837Sgabeblack@google.comclass sc_inout; 5512837Sgabeblack@google.comtemplate <class T> 5612837Sgabeblack@google.comclass sc_signal_in_if; 5712837Sgabeblack@google.com 5812837Sgabeblack@google.comclass sc_event; 5912837Sgabeblack@google.comclass sc_event_and_list; 6012837Sgabeblack@google.comclass sc_event_or_list; 6112837Sgabeblack@google.comclass sc_module_name; 6212837Sgabeblack@google.com 6312837Sgabeblack@google.comclass sc_bind_proxy 6412837Sgabeblack@google.com{ 6512837Sgabeblack@google.com public: 6612837Sgabeblack@google.com sc_bind_proxy(const sc_interface &interface); 6712837Sgabeblack@google.com sc_bind_proxy(const sc_port_base &port); 6812837Sgabeblack@google.com}; 6912837Sgabeblack@google.com 7012837Sgabeblack@google.comextern const sc_bind_proxy SC_BIND_PROXY_NIL; 7112837Sgabeblack@google.com 7212837Sgabeblack@google.comclass sc_module : public sc_object 7312837Sgabeblack@google.com{ 7412837Sgabeblack@google.com public: 7512837Sgabeblack@google.com virtual ~sc_module(); 7612837Sgabeblack@google.com 7712837Sgabeblack@google.com virtual const char *kind() const; 7812837Sgabeblack@google.com 7912837Sgabeblack@google.com void operator () (const sc_bind_proxy &p001, 8012837Sgabeblack@google.com const sc_bind_proxy &p002 = SC_BIND_PROXY_NIL, 8112837Sgabeblack@google.com const sc_bind_proxy &p003 = SC_BIND_PROXY_NIL, 8212837Sgabeblack@google.com const sc_bind_proxy &p004 = SC_BIND_PROXY_NIL, 8312837Sgabeblack@google.com const sc_bind_proxy &p005 = SC_BIND_PROXY_NIL, 8412837Sgabeblack@google.com const sc_bind_proxy &p006 = SC_BIND_PROXY_NIL, 8512837Sgabeblack@google.com const sc_bind_proxy &p007 = SC_BIND_PROXY_NIL, 8612837Sgabeblack@google.com const sc_bind_proxy &p008 = SC_BIND_PROXY_NIL, 8712837Sgabeblack@google.com const sc_bind_proxy &p009 = SC_BIND_PROXY_NIL, 8812837Sgabeblack@google.com const sc_bind_proxy &p010 = SC_BIND_PROXY_NIL, 8912837Sgabeblack@google.com const sc_bind_proxy &p011 = SC_BIND_PROXY_NIL, 9012837Sgabeblack@google.com const sc_bind_proxy &p012 = SC_BIND_PROXY_NIL, 9112837Sgabeblack@google.com const sc_bind_proxy &p013 = SC_BIND_PROXY_NIL, 9212837Sgabeblack@google.com const sc_bind_proxy &p014 = SC_BIND_PROXY_NIL, 9312837Sgabeblack@google.com const sc_bind_proxy &p015 = SC_BIND_PROXY_NIL, 9412837Sgabeblack@google.com const sc_bind_proxy &p016 = SC_BIND_PROXY_NIL, 9512837Sgabeblack@google.com const sc_bind_proxy &p017 = SC_BIND_PROXY_NIL, 9612837Sgabeblack@google.com const sc_bind_proxy &p018 = SC_BIND_PROXY_NIL, 9712837Sgabeblack@google.com const sc_bind_proxy &p019 = SC_BIND_PROXY_NIL, 9812837Sgabeblack@google.com const sc_bind_proxy &p020 = SC_BIND_PROXY_NIL, 9912837Sgabeblack@google.com const sc_bind_proxy &p021 = SC_BIND_PROXY_NIL, 10012837Sgabeblack@google.com const sc_bind_proxy &p022 = SC_BIND_PROXY_NIL, 10112837Sgabeblack@google.com const sc_bind_proxy &p023 = SC_BIND_PROXY_NIL, 10212837Sgabeblack@google.com const sc_bind_proxy &p024 = SC_BIND_PROXY_NIL, 10312837Sgabeblack@google.com const sc_bind_proxy &p025 = SC_BIND_PROXY_NIL, 10412837Sgabeblack@google.com const sc_bind_proxy &p026 = SC_BIND_PROXY_NIL, 10512837Sgabeblack@google.com const sc_bind_proxy &p027 = SC_BIND_PROXY_NIL, 10612837Sgabeblack@google.com const sc_bind_proxy &p028 = SC_BIND_PROXY_NIL, 10712837Sgabeblack@google.com const sc_bind_proxy &p029 = SC_BIND_PROXY_NIL, 10812837Sgabeblack@google.com const sc_bind_proxy &p030 = SC_BIND_PROXY_NIL, 10912837Sgabeblack@google.com const sc_bind_proxy &p031 = SC_BIND_PROXY_NIL, 11012837Sgabeblack@google.com const sc_bind_proxy &p032 = SC_BIND_PROXY_NIL, 11112837Sgabeblack@google.com const sc_bind_proxy &p033 = SC_BIND_PROXY_NIL, 11212837Sgabeblack@google.com const sc_bind_proxy &p034 = SC_BIND_PROXY_NIL, 11312837Sgabeblack@google.com const sc_bind_proxy &p035 = SC_BIND_PROXY_NIL, 11412837Sgabeblack@google.com const sc_bind_proxy &p036 = SC_BIND_PROXY_NIL, 11512837Sgabeblack@google.com const sc_bind_proxy &p037 = SC_BIND_PROXY_NIL, 11612837Sgabeblack@google.com const sc_bind_proxy &p038 = SC_BIND_PROXY_NIL, 11712837Sgabeblack@google.com const sc_bind_proxy &p039 = SC_BIND_PROXY_NIL, 11812837Sgabeblack@google.com const sc_bind_proxy &p040 = SC_BIND_PROXY_NIL, 11912837Sgabeblack@google.com const sc_bind_proxy &p041 = SC_BIND_PROXY_NIL, 12012837Sgabeblack@google.com const sc_bind_proxy &p042 = SC_BIND_PROXY_NIL, 12112837Sgabeblack@google.com const sc_bind_proxy &p043 = SC_BIND_PROXY_NIL, 12212837Sgabeblack@google.com const sc_bind_proxy &p044 = SC_BIND_PROXY_NIL, 12312837Sgabeblack@google.com const sc_bind_proxy &p045 = SC_BIND_PROXY_NIL, 12412837Sgabeblack@google.com const sc_bind_proxy &p046 = SC_BIND_PROXY_NIL, 12512837Sgabeblack@google.com const sc_bind_proxy &p047 = SC_BIND_PROXY_NIL, 12612837Sgabeblack@google.com const sc_bind_proxy &p048 = SC_BIND_PROXY_NIL, 12712837Sgabeblack@google.com const sc_bind_proxy &p049 = SC_BIND_PROXY_NIL, 12812837Sgabeblack@google.com const sc_bind_proxy &p050 = SC_BIND_PROXY_NIL, 12912837Sgabeblack@google.com const sc_bind_proxy &p051 = SC_BIND_PROXY_NIL, 13012837Sgabeblack@google.com const sc_bind_proxy &p052 = SC_BIND_PROXY_NIL, 13112837Sgabeblack@google.com const sc_bind_proxy &p053 = SC_BIND_PROXY_NIL, 13212837Sgabeblack@google.com const sc_bind_proxy &p054 = SC_BIND_PROXY_NIL, 13312837Sgabeblack@google.com const sc_bind_proxy &p055 = SC_BIND_PROXY_NIL, 13412837Sgabeblack@google.com const sc_bind_proxy &p056 = SC_BIND_PROXY_NIL, 13512837Sgabeblack@google.com const sc_bind_proxy &p057 = SC_BIND_PROXY_NIL, 13612837Sgabeblack@google.com const sc_bind_proxy &p058 = SC_BIND_PROXY_NIL, 13712837Sgabeblack@google.com const sc_bind_proxy &p059 = SC_BIND_PROXY_NIL, 13812837Sgabeblack@google.com const sc_bind_proxy &p060 = SC_BIND_PROXY_NIL, 13912837Sgabeblack@google.com const sc_bind_proxy &p061 = SC_BIND_PROXY_NIL, 14012837Sgabeblack@google.com const sc_bind_proxy &p062 = SC_BIND_PROXY_NIL, 14112837Sgabeblack@google.com const sc_bind_proxy &p063 = SC_BIND_PROXY_NIL, 14212837Sgabeblack@google.com const sc_bind_proxy &p064 = SC_BIND_PROXY_NIL); 14312837Sgabeblack@google.com 14412837Sgabeblack@google.com virtual const std::vector<sc_object *> &get_child_objects() const; 14512837Sgabeblack@google.com virtual const std::vector<sc_event *> &get_child_events() const; 14612837Sgabeblack@google.com 14712837Sgabeblack@google.com protected: 14812837Sgabeblack@google.com sc_module(const sc_module_name &); 14912837Sgabeblack@google.com sc_module(); 15012837Sgabeblack@google.com 15112928Sgabeblack@google.com // Deprecated 15212928Sgabeblack@google.com sc_module(const char *); 15312928Sgabeblack@google.com sc_module(const std::string &); 15412928Sgabeblack@google.com 15512864Sgabeblack@google.com /* Deprecated, but used in the regression tests. */ 15612864Sgabeblack@google.com void end_module() {} 15712864Sgabeblack@google.com 15812837Sgabeblack@google.com void reset_signal_is(const sc_in<bool> &, bool); 15912837Sgabeblack@google.com void reset_signal_is(const sc_inout<bool> &, bool); 16012837Sgabeblack@google.com void reset_signal_is(const sc_out<bool> &, bool); 16112837Sgabeblack@google.com void reset_signal_is(const sc_signal_in_if<bool> &, bool); 16212837Sgabeblack@google.com 16312837Sgabeblack@google.com void async_reset_signal_is(const sc_in<bool> &, bool); 16412837Sgabeblack@google.com void async_reset_signal_is(const sc_inout<bool> &, bool); 16512837Sgabeblack@google.com void async_reset_signal_is(const sc_out<bool> &, bool); 16612837Sgabeblack@google.com void async_reset_signal_is(const sc_signal_in_if<bool> &, bool); 16712837Sgabeblack@google.com 16812837Sgabeblack@google.com sc_sensitive sensitive; 16912837Sgabeblack@google.com 17012837Sgabeblack@google.com void dont_initialize(); 17112837Sgabeblack@google.com void set_stack_size(size_t); 17212837Sgabeblack@google.com 17312837Sgabeblack@google.com void next_trigger(); 17412837Sgabeblack@google.com void next_trigger(const sc_event &); 17512837Sgabeblack@google.com void next_trigger(const sc_event_or_list &); 17612837Sgabeblack@google.com void next_trigger(const sc_event_and_list &); 17712837Sgabeblack@google.com void next_trigger(const sc_time &); 17812837Sgabeblack@google.com void next_trigger(double, sc_time_unit); 17912837Sgabeblack@google.com void next_trigger(const sc_time &, const sc_event &); 18012837Sgabeblack@google.com void next_trigger(double, sc_time_unit, const sc_event &); 18112837Sgabeblack@google.com void next_trigger(const sc_time &, const sc_event_or_list &); 18212837Sgabeblack@google.com void next_trigger(double, sc_time_unit, const sc_event_or_list &); 18312837Sgabeblack@google.com void next_trigger(const sc_time &, const sc_event_and_list &); 18412837Sgabeblack@google.com void next_trigger(double, sc_time_unit, const sc_event_and_list &); 18512837Sgabeblack@google.com 18612929Sgabeblack@google.com // Nonstandard 18712929Sgabeblack@google.com bool timed_out(); 18812929Sgabeblack@google.com 18912837Sgabeblack@google.com void wait(); 19012837Sgabeblack@google.com void wait(int); 19112837Sgabeblack@google.com void wait(const sc_event &); 19212837Sgabeblack@google.com void wait(const sc_event_or_list &); 19312837Sgabeblack@google.com void wait(const sc_event_and_list &); 19412837Sgabeblack@google.com void wait(const sc_time &); 19512837Sgabeblack@google.com void wait(double, sc_time_unit); 19612837Sgabeblack@google.com void wait(const sc_time &, const sc_event &); 19712837Sgabeblack@google.com void wait(double, sc_time_unit, const sc_event &); 19812837Sgabeblack@google.com void wait(const sc_time &, const sc_event_or_list &); 19912837Sgabeblack@google.com void wait(double, sc_time_unit, const sc_event_or_list &); 20012837Sgabeblack@google.com void wait(const sc_time &, const sc_event_and_list &); 20112837Sgabeblack@google.com void wait(double, sc_time_unit, const sc_event_and_list &); 20212837Sgabeblack@google.com 20312914Sgabeblack@google.com // Nonstandard 20412909Sgabeblack@google.com void halt(); 20512914Sgabeblack@google.com void at_posedge(const sc_signal_in_if<bool> &); 20612914Sgabeblack@google.com void at_posedge(const sc_signal_in_if<sc_dt::sc_logic> &); 20712914Sgabeblack@google.com void at_negedge(const sc_signal_in_if<bool> &); 20812914Sgabeblack@google.com void at_negedge(const sc_signal_in_if<sc_dt::sc_logic> &); 20912909Sgabeblack@google.com 21012837Sgabeblack@google.com virtual void before_end_of_elaboration() {} 21112837Sgabeblack@google.com virtual void end_of_elaboration() {} 21212837Sgabeblack@google.com virtual void start_of_simulation() {} 21312837Sgabeblack@google.com virtual void end_of_simulation() {} 21412837Sgabeblack@google.com 21512837Sgabeblack@google.com private: 21612837Sgabeblack@google.com // Disabled 21712837Sgabeblack@google.com sc_module(const sc_module &) : sc_object() {}; 21812837Sgabeblack@google.com sc_module &operator = (const sc_module &) { return *this; } 21912837Sgabeblack@google.com}; 22012837Sgabeblack@google.com 22112837Sgabeblack@google.comvoid next_trigger(); 22212837Sgabeblack@google.comvoid next_trigger(const sc_event &); 22312837Sgabeblack@google.comvoid next_trigger(const sc_event_or_list &); 22412837Sgabeblack@google.comvoid next_trigger(const sc_event_and_list &); 22512837Sgabeblack@google.comvoid next_trigger(const sc_time &); 22612837Sgabeblack@google.comvoid next_trigger(double, sc_time_unit); 22712837Sgabeblack@google.comvoid next_trigger(const sc_time &, const sc_event &); 22812837Sgabeblack@google.comvoid next_trigger(double, sc_time_unit, const sc_event &); 22912837Sgabeblack@google.comvoid next_trigger(const sc_time &, const sc_event_or_list &); 23012837Sgabeblack@google.comvoid next_trigger(double, sc_time_unit, const sc_event_or_list &); 23112837Sgabeblack@google.comvoid next_trigger(const sc_time &, const sc_event_and_list &); 23212837Sgabeblack@google.comvoid next_trigger(double, sc_time_unit, const sc_event_and_list &); 23312837Sgabeblack@google.com 23412837Sgabeblack@google.comvoid wait(); 23512837Sgabeblack@google.comvoid wait(int); 23612837Sgabeblack@google.comvoid wait(const sc_event &); 23712837Sgabeblack@google.comvoid wait(const sc_event_or_list &); 23812837Sgabeblack@google.comvoid wait(const sc_event_and_list &); 23912837Sgabeblack@google.comvoid wait(const sc_time &); 24012837Sgabeblack@google.comvoid wait(double, sc_time_unit); 24112837Sgabeblack@google.comvoid wait(const sc_time &, const sc_event &); 24212837Sgabeblack@google.comvoid wait(double, sc_time_unit, const sc_event &); 24312837Sgabeblack@google.comvoid wait(const sc_time &, const sc_event_or_list &); 24412837Sgabeblack@google.comvoid wait(double, sc_time_unit, const sc_event_or_list &); 24512837Sgabeblack@google.comvoid wait(const sc_time &, const sc_event_and_list &); 24612837Sgabeblack@google.comvoid wait(double, sc_time_unit, const sc_event_and_list &); 24712837Sgabeblack@google.com 24812929Sgabeblack@google.com// Nonstandard 24912929Sgabeblack@google.combool timed_out(); 25012929Sgabeblack@google.com 25112837Sgabeblack@google.com#define SC_MODULE(name) struct name : ::sc_core::sc_module 25212837Sgabeblack@google.com 25312837Sgabeblack@google.com#define SC_CTOR(name) \ 25412837Sgabeblack@google.com typedef name SC_CURRENT_USER_MODULE; \ 25512837Sgabeblack@google.com name(::sc_core::sc_module_name) 25612837Sgabeblack@google.com 25712837Sgabeblack@google.com#define SC_HAS_PROCESS(name) typedef name SC_CURRENT_USER_MODULE 25812837Sgabeblack@google.com 25912837Sgabeblack@google.com#define SC_METHOD(name) /* Implementation defined */ 26012837Sgabeblack@google.com#define SC_THREAD(name) /* Implementation defined */ 26112837Sgabeblack@google.com#define SC_CTHREAD(name, clk) /* Implementation defined */ 26212837Sgabeblack@google.com 26312909Sgabeblack@google.com// Nonstandard 26412909Sgabeblack@google.com// Documentation for this is very scarce, but it looks like it's supposed to 26512909Sgabeblack@google.com// stop the currently executing cthread, or if a cthread isn't running report 26612909Sgabeblack@google.com// an error. 26712909Sgabeblack@google.comvoid halt(); 26812914Sgabeblack@google.comvoid at_posedge(const sc_signal_in_if<bool> &); 26912914Sgabeblack@google.comvoid at_posedge(const sc_signal_in_if<sc_dt::sc_logic> &); 27012914Sgabeblack@google.comvoid at_negedge(const sc_signal_in_if<bool> &); 27112914Sgabeblack@google.comvoid at_negedge(const sc_signal_in_if<sc_dt::sc_logic> &); 27212909Sgabeblack@google.com 27312837Sgabeblack@google.comconst char *sc_gen_unique_name(const char *); 27412837Sgabeblack@google.com 27512930Sgabeblack@google.com// Nonstandard 27612930Sgabeblack@google.combool sc_hierarchical_name_exists(const char *name); 27712930Sgabeblack@google.com 27812837Sgabeblack@google.comtypedef sc_module sc_behavior; 27912837Sgabeblack@google.comtypedef sc_module sc_channel; 28012837Sgabeblack@google.com 28112837Sgabeblack@google.combool sc_start_of_simulation_invoked(); 28212837Sgabeblack@google.combool sc_end_of_simulation_invoked(); 28312837Sgabeblack@google.com 28412901Sgabeblack@google.com// Nonstandard 28512901Sgabeblack@google.com// Allocates a module of type x and records a pointer to it so that it gets 28612901Sgabeblack@google.com// destructed automatically at the end of the simulation. 28712901Sgabeblack@google.comsc_module *sc_module_sc_new(sc_module *); 28812901Sgabeblack@google.com#define SC_NEW(x) ::sc_core::sc_module_sc_new(new x); 28912901Sgabeblack@google.com 29012907Sgabeblack@google.com// Nonstandard 29112907Sgabeblack@google.com// In the Accellera implementation, this macro calls sc_set_location to record 29212907Sgabeblack@google.com// the current file and line, calls wait, and then calls it again to clear the 29312907Sgabeblack@google.com// file and line. We'll ignore the sc_set_location calls for now. 29412907Sgabeblack@google.com#define SC_WAIT() ::sc_core::wait(); 29512907Sgabeblack@google.com 29612907Sgabeblack@google.com// Nonstandard 29712907Sgabeblack@google.com// Same as above, but passes through an argument. 29812907Sgabeblack@google.com#define SC_WAITN(n) ::sc_core::wait(n); 29912907Sgabeblack@google.com 30012907Sgabeblack@google.com// Nonstandard 30112907Sgabeblack@google.com#define SC_WAIT_UNTIL(expr) do { SC_WAIT(); } while (!(expr)) 30212907Sgabeblack@google.com 30312837Sgabeblack@google.com} // namespace sc_core 30412837Sgabeblack@google.com 30512837Sgabeblack@google.com#endif //__SYSTEMC_EXT_CORE_SC_MODULE_HH__ 306