sc_main.hh (12926:2b4c3973269f) sc_main.hh (13043:3d8585dabc3e)
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_EXT_CORE_SC_MAIN_HH__
31#define __SYSTEMC_EXT_CORE_SC_MAIN_HH__
32
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_EXT_CORE_SC_MAIN_HH__
31#define __SYSTEMC_EXT_CORE_SC_MAIN_HH__
32
33#include <iostream>
34
33#include "../dt/int/sc_nbdefs.hh"
34#include "sc_time.hh"
35
36extern "C" int sc_main(int argc, char *argv[]);
37
38namespace sc_core
39{
40 extern "C" int sc_argc();
41
42 // The standard version of this function doesn't have these "const"
43 // qualifiers, but the canonical SystemC implementation does.
44 extern "C" const char *const *sc_argv();
45
46 enum sc_starvation_policy
47 {
48 SC_RUN_TO_TIME,
49 SC_EXIT_ON_STARVATION
50 };
51
52 void sc_start();
53 void sc_start(const sc_time &, sc_starvation_policy p=SC_RUN_TO_TIME);
54 static inline void
55 sc_start(double d, sc_time_unit t, sc_starvation_policy p=SC_RUN_TO_TIME)
56 {
57 sc_start(sc_time(d, t), p);
58 }
59
60 void sc_pause();
61
62 enum sc_stop_mode
63 {
64 SC_STOP_FINISH_DELTA,
65 SC_STOP_IMMEDIATE,
66 };
67
68 void sc_set_stop_mode(sc_stop_mode mode);
69 sc_stop_mode sc_get_stop_mode();
70
71 void sc_stop();
72
73 const sc_time &sc_time_stamp();
74 sc_dt::uint64 sc_delta_count();
75 bool sc_is_running();
76 bool sc_pending_activity_at_current_time();
77 bool sc_pending_activity_at_future_time();
78 bool sc_pending_activity();
79 sc_time sc_time_to_pending_activity();
80
81 enum sc_status
82 {
83 SC_ELABORATION = 0x1,
84 SC_BEFORE_END_OF_ELABORATION = 0x02,
85 SC_END_OF_ELABORATION = 0x04,
86 SC_START_OF_SIMULATION = 0x08,
87 SC_RUNNING = 0x10,
88 SC_PAUSED = 0x20,
89 SC_STOPPED = 0x40,
90 SC_END_OF_SIMULATION = 0x80,
91
92 // Nonstandard
93 SC_END_OF_INITIALIZATION = 0x100,
94 SC_END_OF_UPDATE = 0x400,
95 SC_BEFORE_TIMESTEP = 0x800,
96 SC_STATUS_ANY = 0xdff
97 };
98
99 sc_status sc_get_status();
35#include "../dt/int/sc_nbdefs.hh"
36#include "sc_time.hh"
37
38extern "C" int sc_main(int argc, char *argv[]);
39
40namespace sc_core
41{
42 extern "C" int sc_argc();
43
44 // The standard version of this function doesn't have these "const"
45 // qualifiers, but the canonical SystemC implementation does.
46 extern "C" const char *const *sc_argv();
47
48 enum sc_starvation_policy
49 {
50 SC_RUN_TO_TIME,
51 SC_EXIT_ON_STARVATION
52 };
53
54 void sc_start();
55 void sc_start(const sc_time &, sc_starvation_policy p=SC_RUN_TO_TIME);
56 static inline void
57 sc_start(double d, sc_time_unit t, sc_starvation_policy p=SC_RUN_TO_TIME)
58 {
59 sc_start(sc_time(d, t), p);
60 }
61
62 void sc_pause();
63
64 enum sc_stop_mode
65 {
66 SC_STOP_FINISH_DELTA,
67 SC_STOP_IMMEDIATE,
68 };
69
70 void sc_set_stop_mode(sc_stop_mode mode);
71 sc_stop_mode sc_get_stop_mode();
72
73 void sc_stop();
74
75 const sc_time &sc_time_stamp();
76 sc_dt::uint64 sc_delta_count();
77 bool sc_is_running();
78 bool sc_pending_activity_at_current_time();
79 bool sc_pending_activity_at_future_time();
80 bool sc_pending_activity();
81 sc_time sc_time_to_pending_activity();
82
83 enum sc_status
84 {
85 SC_ELABORATION = 0x1,
86 SC_BEFORE_END_OF_ELABORATION = 0x02,
87 SC_END_OF_ELABORATION = 0x04,
88 SC_START_OF_SIMULATION = 0x08,
89 SC_RUNNING = 0x10,
90 SC_PAUSED = 0x20,
91 SC_STOPPED = 0x40,
92 SC_END_OF_SIMULATION = 0x80,
93
94 // Nonstandard
95 SC_END_OF_INITIALIZATION = 0x100,
96 SC_END_OF_UPDATE = 0x400,
97 SC_BEFORE_TIMESTEP = 0x800,
98 SC_STATUS_ANY = 0xdff
99 };
100
101 sc_status sc_get_status();
102
103 std::ostream &operator << (std::ostream &os, sc_status s);
100} // namespace sc_core
101
102#endif //__SYSTEMC_EXT_CORE_SC_MAIN_HH__
104} // namespace sc_core
105
106#endif //__SYSTEMC_EXT_CORE_SC_MAIN_HH__