sc_process_handle.hh revision 12898:9c24286c7ddb 
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
36namespace sc_gem5
37{
38
39class Process;
40
41} // namespace sc_gem5
42
43namespace sc_core
44{
45
46class sc_event;
47class sc_object;
48
49enum sc_curr_proc_kind
50{
51    SC_NO_PROC_,
52    SC_METHOD_PROC_,
53    SC_THREAD_PROC_,
54    SC_CTHREAD_PROC_
55};
56
57enum sc_descendent_inclusion_info
58{
59    SC_NO_DESCENDANTS,
60    SC_INCLUDE_DESCENDANTS
61};
62
63class sc_unwind_exception : public std::exception
64{
65  public:
66    virtual const char *what() const throw();
67    virtual bool is_reset() const;
68
69    // Nonstandard.
70    // These should be protected, but I think this is to enable catch by
71    // value.
72  public:
73    sc_unwind_exception(const sc_unwind_exception &);
74    virtual ~sc_unwind_exception() throw();
75
76  protected:
77    sc_unwind_exception();
78};
79
80class sc_process_handle
81{
82  private:
83    ::sc_gem5::Process *_gem5_process;
84
85  public:
86    sc_process_handle();
87    sc_process_handle(const sc_process_handle &);
88    explicit sc_process_handle(sc_object *);
89    ~sc_process_handle();
90
91    // These non-standard operators provide access to the data structure which
92    // actually tracks the process within gem5. By making them operators, we
93    // can minimize the symbols added to the class namespace.
94    operator ::sc_gem5::Process * () const { return _gem5_process; }
95    sc_process_handle &
96    operator = (::sc_gem5::Process *p)
97    {
98        _gem5_process = p;
99        return *this;
100    }
101
102    bool valid() const;
103
104    sc_process_handle &operator = (const sc_process_handle &);
105    bool operator == (const sc_process_handle &) const;
106    bool operator != (const sc_process_handle &) const;
107    bool operator < (const sc_process_handle &) const;
108    bool swap(sc_process_handle &);
109
110    const char *name() const;
111    sc_curr_proc_kind proc_kind() const;
112    const std::vector<sc_object *> &get_child_objects() const;
113    const std::vector<sc_event *> &get_child_events() const;
114    sc_object *get_parent_object() const;
115    sc_object *get_process_object() const;
116    bool dynamic() const;
117    bool terminated() const;
118    const sc_event &terminated_event() const;
119
120    void suspend(sc_descendent_inclusion_info include_descendants=
121                 SC_NO_DESCENDANTS);
122    void resume(sc_descendent_inclusion_info include_descendants=
123                SC_NO_DESCENDANTS);
124    void disable(sc_descendent_inclusion_info include_descendants=
125                 SC_NO_DESCENDANTS);
126    void enable(sc_descendent_inclusion_info include_descendants=
127                SC_NO_DESCENDANTS);
128    void kill(sc_descendent_inclusion_info include_descendants=
129              SC_NO_DESCENDANTS);
130    void reset(sc_descendent_inclusion_info include_descendants=
131               SC_NO_DESCENDANTS);
132    bool is_unwinding();
133    const sc_event &reset_event() const;
134
135    void sync_reset_on(sc_descendent_inclusion_info include_descendants=
136                       SC_NO_DESCENDANTS);
137    void sync_reset_off(sc_descendent_inclusion_info include_descendants=
138                        SC_NO_DESCENDANTS);
139
140    void warn_unimpl(const char *func);
141    template <typename T>
142    void throw_it(const T &user_defined_exception,
143                  sc_descendent_inclusion_info include_descendants=
144                  SC_NO_DESCENDANTS)
145    {
146        warn_unimpl(__PRETTY_FUNCTION__);
147    }
148};
149
150sc_process_handle sc_get_current_process_handle();
151bool sc_is_unwinding();
152
153} // namespace sc_core
154
155#endif  //__SYSTEMC_EXT_CORE_SC_PROCESS_HANDLE_HH__
156