sc_process_handle.hh revision 13087 
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_PROCESS_HANDLE_HH__
31#define __SYSTEMC_EXT_CORE_SC_PROCESS_HANDLE_HH__
32
33#include <exception>
34#include <vector>
35
36#include "systemc/ext/core/sc_object.hh"
37
38namespace sc_gem5
39{
40
41class Process;
42
43struct ProcessFuncWrapper
44{
45    virtual void call() = 0;
46    virtual ~ProcessFuncWrapper() {}
47};
48
49template <typename T>
50struct ProcessMemberFuncWrapper : public ProcessFuncWrapper
51{
52    typedef void (T::*TFunc)();
53    T *t;
54    TFunc func;
55
56    ProcessMemberFuncWrapper(T *t, TFunc func) : t(t), func(func) {}
57
58    void call() override { (t->*func)(); }
59};
60
61struct ExceptionWrapperBase
62{
63    virtual void throw_it() = 0;
64};
65
66template <typename T>
67struct ExceptionWrapper : public ExceptionWrapperBase
68{
69    const T &t;
70    ExceptionWrapper(const T &t) : t(t) {}
71
72    void throw_it() { throw t; }
73};
74
75void throw_it_wrapper(Process *p, ExceptionWrapperBase &exc, bool inc_kids);
76
77} // namespace sc_gem5
78
79namespace sc_core
80{
81
82class sc_event;
83
84enum sc_curr_proc_kind
85{
86    SC_NO_PROC_,
87    SC_METHOD_PROC_,
88    SC_THREAD_PROC_,
89    SC_CTHREAD_PROC_
90};
91
92enum sc_descendent_inclusion_info
93{
94    SC_NO_DESCENDANTS,
95    SC_INCLUDE_DESCENDANTS
96};
97
98class sc_unwind_exception : public std::exception
99{
100  public:
101    virtual const char *what() const throw();
102    virtual bool is_reset() const;
103
104    // Nonstandard.
105    // These should be protected, but I think this is to enable catch by
106    // value.
107  public:
108    sc_unwind_exception(const sc_unwind_exception &);
109    virtual ~sc_unwind_exception() throw();
110
111  protected:
112    bool _isReset;
113    sc_unwind_exception();
114};
115
116// Deprecated
117// An incomplete version of sc_process_b to satisfy the tests.
118class sc_process_b : public sc_object
119{
120  public:
121    sc_process_b(const char *name) : sc_object(name), file(nullptr), lineno(0)
122    {}
123    sc_process_b() : sc_object(), file(nullptr), lineno(0) {}
124
125    const char *file;
126    int lineno;
127};
128
129// Nonstandard
130void sc_set_location(const char *file, int lineno);
131
132// Deprecated
133sc_process_b *sc_get_curr_process_handle();
134static inline sc_process_b *
135sc_get_current_process_b()
136{
137    return sc_get_curr_process_handle();
138}
139
140// Deprecated/nonstandard
141struct sc_curr_proc_info
142{
143    sc_process_b *process_handle;
144    sc_curr_proc_kind kind;
145    sc_curr_proc_info() : process_handle(NULL), kind(SC_NO_PROC_) {}
146};
147typedef const sc_curr_proc_info *sc_curr_proc_handle;
148
149class sc_process_handle
150{
151  private:
152    ::sc_gem5::Process *_gem5_process;
153
154  public:
155    sc_process_handle();
156    sc_process_handle(const sc_process_handle &);
157    explicit sc_process_handle(sc_object *);
158    ~sc_process_handle();
159
160    // These non-standard operators provide access to the data structure which
161    // actually tracks the process within gem5. By making them operators, we
162    // can minimize the symbols added to the class namespace.
163    operator ::sc_gem5::Process * () const { return _gem5_process; }
164    sc_process_handle &
165    operator = (::sc_gem5::Process *p)
166    {
167        _gem5_process = p;
168        return *this;
169    }
170
171    bool valid() const;
172
173    sc_process_handle &operator = (const sc_process_handle &);
174    bool operator == (const sc_process_handle &) const;
175    bool operator != (const sc_process_handle &) const;
176    bool operator < (const sc_process_handle &) const;
177    void swap(sc_process_handle &);
178
179    const char *name() const;
180    sc_curr_proc_kind proc_kind() const;
181    const std::vector<sc_object *> &get_child_objects() const;
182    const std::vector<sc_event *> &get_child_events() const;
183    sc_object *get_parent_object() const;
184    sc_object *get_process_object() const;
185    bool dynamic() const;
186    bool terminated() const;
187    const sc_event &terminated_event() const;
188
189    void suspend(sc_descendent_inclusion_info include_descendants=
190                 SC_NO_DESCENDANTS);
191    void resume(sc_descendent_inclusion_info include_descendants=
192                SC_NO_DESCENDANTS);
193    void disable(sc_descendent_inclusion_info include_descendants=
194                 SC_NO_DESCENDANTS);
195    void enable(sc_descendent_inclusion_info include_descendants=
196                SC_NO_DESCENDANTS);
197    void kill(sc_descendent_inclusion_info include_descendants=
198              SC_NO_DESCENDANTS);
199    void reset(sc_descendent_inclusion_info include_descendants=
200               SC_NO_DESCENDANTS);
201    bool is_unwinding();
202    const sc_event &reset_event() const;
203
204    void sync_reset_on(sc_descendent_inclusion_info include_descendants=
205                       SC_NO_DESCENDANTS);
206    void sync_reset_off(sc_descendent_inclusion_info include_descendants=
207                        SC_NO_DESCENDANTS);
208
209    template <typename T>
210    void
211    throw_it(const T &user_defined_exception,
212             sc_descendent_inclusion_info include_descendants=
213             SC_NO_DESCENDANTS)
214    {
215        ::sc_gem5::ExceptionWrapper<T> exc(user_defined_exception);
216        ::sc_gem5::throw_it_wrapper(_gem5_process, exc,
217                include_descendants == SC_INCLUDE_DESCENDANTS);
218    }
219};
220
221sc_process_handle sc_get_current_process_handle();
222bool sc_is_unwinding();
223
224// Nonstandard
225// See Accellera's kernel/sim_context.cpp for an explanation of what this is
226// supposed to do. It essentially selects what happens during certain
227// undefined situations.
228extern bool sc_allow_process_control_corners;
229
230} // namespace sc_core
231
232#endif  //__SYSTEMC_EXT_CORE_SC_PROCESS_HANDLE_HH__
233