sc_module.hh revision 12907 
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_CORE_EXT_SC_MODULE_HH__
31#define __SYSTEMC_CORE_EXT_SC_MODULE_HH__
32
33#include <vector>
34
35#include "sc_object.hh"
36#include "sc_sensitive.hh"
37#include "sc_time.hh"
38
39namespace sc_core
40{
41
42template <class T>
43class sc_in;
44template <class T>
45class sc_out;
46template <class T>
47class sc_inout;
48template <class T>
49class sc_signal_in_if;
50
51class sc_event;
52class sc_event_and_list;
53class sc_event_or_list;
54class sc_module_name;
55
56class sc_bind_proxy
57{
58  public:
59    sc_bind_proxy(const sc_interface &interface);
60    sc_bind_proxy(const sc_port_base &port);
61};
62
63extern const sc_bind_proxy SC_BIND_PROXY_NIL;
64
65class sc_module : public sc_object
66{
67  public:
68    virtual ~sc_module();
69
70    virtual const char *kind() const;
71
72    void operator () (const sc_bind_proxy &p001,
73                      const sc_bind_proxy &p002 = SC_BIND_PROXY_NIL,
74                      const sc_bind_proxy &p003 = SC_BIND_PROXY_NIL,
75                      const sc_bind_proxy &p004 = SC_BIND_PROXY_NIL,
76                      const sc_bind_proxy &p005 = SC_BIND_PROXY_NIL,
77                      const sc_bind_proxy &p006 = SC_BIND_PROXY_NIL,
78                      const sc_bind_proxy &p007 = SC_BIND_PROXY_NIL,
79                      const sc_bind_proxy &p008 = SC_BIND_PROXY_NIL,
80                      const sc_bind_proxy &p009 = SC_BIND_PROXY_NIL,
81                      const sc_bind_proxy &p010 = SC_BIND_PROXY_NIL,
82                      const sc_bind_proxy &p011 = SC_BIND_PROXY_NIL,
83                      const sc_bind_proxy &p012 = SC_BIND_PROXY_NIL,
84                      const sc_bind_proxy &p013 = SC_BIND_PROXY_NIL,
85                      const sc_bind_proxy &p014 = SC_BIND_PROXY_NIL,
86                      const sc_bind_proxy &p015 = SC_BIND_PROXY_NIL,
87                      const sc_bind_proxy &p016 = SC_BIND_PROXY_NIL,
88                      const sc_bind_proxy &p017 = SC_BIND_PROXY_NIL,
89                      const sc_bind_proxy &p018 = SC_BIND_PROXY_NIL,
90                      const sc_bind_proxy &p019 = SC_BIND_PROXY_NIL,
91                      const sc_bind_proxy &p020 = SC_BIND_PROXY_NIL,
92                      const sc_bind_proxy &p021 = SC_BIND_PROXY_NIL,
93                      const sc_bind_proxy &p022 = SC_BIND_PROXY_NIL,
94                      const sc_bind_proxy &p023 = SC_BIND_PROXY_NIL,
95                      const sc_bind_proxy &p024 = SC_BIND_PROXY_NIL,
96                      const sc_bind_proxy &p025 = SC_BIND_PROXY_NIL,
97                      const sc_bind_proxy &p026 = SC_BIND_PROXY_NIL,
98                      const sc_bind_proxy &p027 = SC_BIND_PROXY_NIL,
99                      const sc_bind_proxy &p028 = SC_BIND_PROXY_NIL,
100                      const sc_bind_proxy &p029 = SC_BIND_PROXY_NIL,
101                      const sc_bind_proxy &p030 = SC_BIND_PROXY_NIL,
102                      const sc_bind_proxy &p031 = SC_BIND_PROXY_NIL,
103                      const sc_bind_proxy &p032 = SC_BIND_PROXY_NIL,
104                      const sc_bind_proxy &p033 = SC_BIND_PROXY_NIL,
105                      const sc_bind_proxy &p034 = SC_BIND_PROXY_NIL,
106                      const sc_bind_proxy &p035 = SC_BIND_PROXY_NIL,
107                      const sc_bind_proxy &p036 = SC_BIND_PROXY_NIL,
108                      const sc_bind_proxy &p037 = SC_BIND_PROXY_NIL,
109                      const sc_bind_proxy &p038 = SC_BIND_PROXY_NIL,
110                      const sc_bind_proxy &p039 = SC_BIND_PROXY_NIL,
111                      const sc_bind_proxy &p040 = SC_BIND_PROXY_NIL,
112                      const sc_bind_proxy &p041 = SC_BIND_PROXY_NIL,
113                      const sc_bind_proxy &p042 = SC_BIND_PROXY_NIL,
114                      const sc_bind_proxy &p043 = SC_BIND_PROXY_NIL,
115                      const sc_bind_proxy &p044 = SC_BIND_PROXY_NIL,
116                      const sc_bind_proxy &p045 = SC_BIND_PROXY_NIL,
117                      const sc_bind_proxy &p046 = SC_BIND_PROXY_NIL,
118                      const sc_bind_proxy &p047 = SC_BIND_PROXY_NIL,
119                      const sc_bind_proxy &p048 = SC_BIND_PROXY_NIL,
120                      const sc_bind_proxy &p049 = SC_BIND_PROXY_NIL,
121                      const sc_bind_proxy &p050 = SC_BIND_PROXY_NIL,
122                      const sc_bind_proxy &p051 = SC_BIND_PROXY_NIL,
123                      const sc_bind_proxy &p052 = SC_BIND_PROXY_NIL,
124                      const sc_bind_proxy &p053 = SC_BIND_PROXY_NIL,
125                      const sc_bind_proxy &p054 = SC_BIND_PROXY_NIL,
126                      const sc_bind_proxy &p055 = SC_BIND_PROXY_NIL,
127                      const sc_bind_proxy &p056 = SC_BIND_PROXY_NIL,
128                      const sc_bind_proxy &p057 = SC_BIND_PROXY_NIL,
129                      const sc_bind_proxy &p058 = SC_BIND_PROXY_NIL,
130                      const sc_bind_proxy &p059 = SC_BIND_PROXY_NIL,
131                      const sc_bind_proxy &p060 = SC_BIND_PROXY_NIL,
132                      const sc_bind_proxy &p061 = SC_BIND_PROXY_NIL,
133                      const sc_bind_proxy &p062 = SC_BIND_PROXY_NIL,
134                      const sc_bind_proxy &p063 = SC_BIND_PROXY_NIL,
135                      const sc_bind_proxy &p064 = SC_BIND_PROXY_NIL);
136
137    virtual const std::vector<sc_object *> &get_child_objects() const;
138    virtual const std::vector<sc_event *> &get_child_events() const;
139
140  protected:
141    sc_module(const sc_module_name &);
142    sc_module();
143
144    /* Deprecated, but used in the regression tests. */
145    void end_module() {}
146
147    void reset_signal_is(const sc_in<bool> &, bool);
148    void reset_signal_is(const sc_inout<bool> &, bool);
149    void reset_signal_is(const sc_out<bool> &, bool);
150    void reset_signal_is(const sc_signal_in_if<bool> &, bool);
151
152    void async_reset_signal_is(const sc_in<bool> &, bool);
153    void async_reset_signal_is(const sc_inout<bool> &, bool);
154    void async_reset_signal_is(const sc_out<bool> &, bool);
155    void async_reset_signal_is(const sc_signal_in_if<bool> &, bool);
156
157    sc_sensitive sensitive;
158
159    void dont_initialize();
160    void set_stack_size(size_t);
161
162    void next_trigger();
163    void next_trigger(const sc_event &);
164    void next_trigger(const sc_event_or_list &);
165    void next_trigger(const sc_event_and_list &);
166    void next_trigger(const sc_time &);
167    void next_trigger(double, sc_time_unit);
168    void next_trigger(const sc_time &, const sc_event &);
169    void next_trigger(double, sc_time_unit, const sc_event &);
170    void next_trigger(const sc_time &, const sc_event_or_list &);
171    void next_trigger(double, sc_time_unit, const sc_event_or_list &);
172    void next_trigger(const sc_time &, const sc_event_and_list &);
173    void next_trigger(double, sc_time_unit, const sc_event_and_list &);
174
175    void wait();
176    void wait(int);
177    void wait(const sc_event &);
178    void wait(const sc_event_or_list &);
179    void wait(const sc_event_and_list &);
180    void wait(const sc_time &);
181    void wait(double, sc_time_unit);
182    void wait(const sc_time &, const sc_event &);
183    void wait(double, sc_time_unit, const sc_event &);
184    void wait(const sc_time &, const sc_event_or_list &);
185    void wait(double, sc_time_unit, const sc_event_or_list &);
186    void wait(const sc_time &, const sc_event_and_list &);
187    void wait(double, sc_time_unit, const sc_event_and_list &);
188
189    virtual void before_end_of_elaboration() {}
190    virtual void end_of_elaboration() {}
191    virtual void start_of_simulation() {}
192    virtual void end_of_simulation() {}
193
194  private:
195    // Disabled
196    sc_module(const sc_module &) : sc_object() {};
197    sc_module &operator = (const sc_module &) { return *this; }
198};
199
200void next_trigger();
201void next_trigger(const sc_event &);
202void next_trigger(const sc_event_or_list &);
203void next_trigger(const sc_event_and_list &);
204void next_trigger(const sc_time &);
205void next_trigger(double, sc_time_unit);
206void next_trigger(const sc_time &, const sc_event &);
207void next_trigger(double, sc_time_unit, const sc_event &);
208void next_trigger(const sc_time &, const sc_event_or_list &);
209void next_trigger(double, sc_time_unit, const sc_event_or_list &);
210void next_trigger(const sc_time &, const sc_event_and_list &);
211void next_trigger(double, sc_time_unit, const sc_event_and_list &);
212
213void wait();
214void wait(int);
215void wait(const sc_event &);
216void wait(const sc_event_or_list &);
217void wait(const sc_event_and_list &);
218void wait(const sc_time &);
219void wait(double, sc_time_unit);
220void wait(const sc_time &, const sc_event &);
221void wait(double, sc_time_unit, const sc_event &);
222void wait(const sc_time &, const sc_event_or_list &);
223void wait(double, sc_time_unit, const sc_event_or_list &);
224void wait(const sc_time &, const sc_event_and_list &);
225void wait(double, sc_time_unit, const sc_event_and_list &);
226
227#define SC_MODULE(name) struct name : ::sc_core::sc_module
228
229#define SC_CTOR(name) \
230    typedef name SC_CURRENT_USER_MODULE; \
231    name(::sc_core::sc_module_name)
232
233#define SC_HAS_PROCESS(name) typedef name SC_CURRENT_USER_MODULE
234
235#define SC_METHOD(name) /* Implementation defined */
236#define SC_THREAD(name) /* Implementation defined */
237#define SC_CTHREAD(name, clk) /* Implementation defined */
238
239const char *sc_gen_unique_name(const char *);
240
241typedef sc_module sc_behavior;
242typedef sc_module sc_channel;
243
244bool sc_start_of_simulation_invoked();
245bool sc_end_of_simulation_invoked();
246
247// Nonstandard
248// Allocates a module of type x and records a pointer to it so that it gets
249// destructed automatically at the end of the simulation.
250sc_module *sc_module_sc_new(sc_module *);
251#define SC_NEW(x) ::sc_core::sc_module_sc_new(new x);
252
253// Nonstandard
254// In the Accellera implementation, this macro calls sc_set_location to record
255// the current file and line, calls wait, and then calls it again to clear the
256// file and line. We'll ignore the sc_set_location calls for now.
257#define SC_WAIT() ::sc_core::wait();
258
259// Nonstandard
260// Same as above, but passes through an argument.
261#define SC_WAITN(n) ::sc_core::wait(n);
262
263// Nonstandard
264#define SC_WAIT_UNTIL(expr) do { SC_WAIT(); } while (!(expr))
265
266} // namespace sc_core
267
268#endif  //__SYSTEMC_EXT_CORE_SC_MODULE_HH__
269