sc_process_handle.hh revision 12939
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 80// Deprecated 81// An incomplete version of sc_process_b to satisfy the tests. 82class sc_process_b 83{ 84 public: 85 const char *file; 86 int lineno; 87 const char *name(); 88 const char *kind(); 89}; 90 91// Deprecated 92sc_process_b *sc_get_curr_process_handle(); 93static inline sc_process_b * 94sc_get_current_process_b() 95{ 96 return sc_get_curr_process_handle(); 97} 98 99// Deprecated/nonstandard 100struct sc_curr_proc_info 101{ 102 sc_process_b *process_handle; 103 sc_curr_proc_kind kind; 104 sc_curr_proc_info() : process_handle(NULL), kind(SC_NO_PROC_) {} 105}; 106typedef const sc_curr_proc_info *sc_curr_proc_handle; 107 108class sc_process_handle 109{ 110 private: 111 ::sc_gem5::Process *_gem5_process; 112 113 public: 114 sc_process_handle(); 115 sc_process_handle(const sc_process_handle &); 116 explicit sc_process_handle(sc_object *); 117 ~sc_process_handle(); 118 119 // These non-standard operators provide access to the data structure which 120 // actually tracks the process within gem5. By making them operators, we 121 // can minimize the symbols added to the class namespace. 122 operator ::sc_gem5::Process * () const { return _gem5_process; } 123 sc_process_handle & 124 operator = (::sc_gem5::Process *p) 125 { 126 _gem5_process = p; 127 return *this; 128 } 129 130 bool valid() const; 131 132 sc_process_handle &operator = (const sc_process_handle &); 133 bool operator == (const sc_process_handle &) const; 134 bool operator != (const sc_process_handle &) const; 135 bool operator < (const sc_process_handle &) const; 136 bool swap(sc_process_handle &); 137 138 const char *name() const; 139 sc_curr_proc_kind proc_kind() const; 140 const std::vector<sc_object *> &get_child_objects() const; 141 const std::vector<sc_event *> &get_child_events() const; 142 sc_object *get_parent_object() const; 143 sc_object *get_process_object() const; 144 bool dynamic() const; 145 bool terminated() const; 146 const sc_event &terminated_event() const; 147 148 void suspend(sc_descendent_inclusion_info include_descendants= 149 SC_NO_DESCENDANTS); 150 void resume(sc_descendent_inclusion_info include_descendants= 151 SC_NO_DESCENDANTS); 152 void disable(sc_descendent_inclusion_info include_descendants= 153 SC_NO_DESCENDANTS); 154 void enable(sc_descendent_inclusion_info include_descendants= 155 SC_NO_DESCENDANTS); 156 void kill(sc_descendent_inclusion_info include_descendants= 157 SC_NO_DESCENDANTS); 158 void reset(sc_descendent_inclusion_info include_descendants= 159 SC_NO_DESCENDANTS); 160 bool is_unwinding(); 161 const sc_event &reset_event() const; 162 163 void sync_reset_on(sc_descendent_inclusion_info include_descendants= 164 SC_NO_DESCENDANTS); 165 void sync_reset_off(sc_descendent_inclusion_info include_descendants= 166 SC_NO_DESCENDANTS); 167 168 void warn_unimpl(const char *func); 169 template <typename T> 170 void throw_it(const T &user_defined_exception, 171 sc_descendent_inclusion_info include_descendants= 172 SC_NO_DESCENDANTS) 173 { 174 warn_unimpl(__PRETTY_FUNCTION__); 175 } 176}; 177 178sc_process_handle sc_get_current_process_handle(); 179bool sc_is_unwinding(); 180 181// Nonstandard 182// See Accellera's kernel/sim_context.cpp for an explanation of what this is 183// supposed to do. It essentially selects what happens during certain 184// undefined situations. 185extern bool sc_allow_process_control_corners; 186 187} // namespace sc_core 188 189#endif //__SYSTEMC_EXT_CORE_SC_PROCESS_HANDLE_HH__ 190