systemc: Stub out the sc_process_handle class.

Change-Id: I2250ccb369e0a5f2b9172d35662a9ce5e41ab1c1
Reviewed-on: https://gem5-review.googlesource.com/10836
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
Maintainer: Gabe Black <gabeblack@google.com>

3 files changed, 411 insertions, 0 deletions

diff --git a/src/systemc/core/SConscript b/src/systemc/core/SConscript
index a94eb0012..4cc6b684c 100644
--- a/src/systemc/core/SConscript
+++ b/src/systemc/core/SConscript
@@ -41,6 +41,7 @@ if env['USE_SYSTEMC']:
     Source('sc_module_name.cc')
     Source('sc_object.cc')
     Source('sc_port.cc')
+    Source('sc_process_handle.cc')
     Source('sc_prim.cc')
     Source('sc_sensitive.cc')
     Source('sc_time.cc')
diff --git a/src/systemc/core/sc_process_handle.cc b/src/systemc/core/sc_process_handle.cc
new file mode 100644
index 000000000..07a07ad97
--- /dev/null
+++ b/src/systemc/core/sc_process_handle.cc
@@ -0,0 +1,281 @@
+/*
+ * Copyright 2018 Google, Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Gabe Black
+ */
+
+#include "base/logging.hh"
+#include "systemc/ext/core/sc_process_handle.hh"
+
+namespace sc_core
+{
+
+const char *
+sc_unwind_exception::what() const throw()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return "";
+}
+
+bool
+sc_unwind_exception::is_reset() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+sc_unwind_exception::sc_unwind_exception()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+sc_unwind_exception::sc_unwind_exception(const sc_unwind_exception &)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+sc_unwind_exception::~sc_unwind_exception() throw()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+
+sc_process_handle::sc_process_handle()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+sc_process_handle::sc_process_handle(const sc_process_handle &)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+sc_process_handle::sc_process_handle(sc_object *)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+sc_process_handle::~sc_process_handle()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+
+bool
+sc_process_handle::valid() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+
+sc_process_handle &
+sc_process_handle::operator = (const sc_process_handle &)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return *this;
+}
+
+bool
+sc_process_handle::operator == (const sc_process_handle &) const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return true;
+}
+
+bool
+sc_process_handle::operator != (const sc_process_handle &) const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+bool
+sc_process_handle::operator < (const sc_process_handle &) const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+bool
+sc_process_handle::swap(sc_process_handle &)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+
+const char *
+sc_process_handle::name() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return "";
+}
+
+sc_curr_proc_kind
+sc_process_handle::proc_kind() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return SC_NO_PROC_;
+}
+
+const std::vector<sc_object *> &
+sc_process_handle::get_child_objects() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return *(const std::vector<sc_object *> *)nullptr;
+}
+
+const std::vector<sc_event *> &
+sc_process_handle::get_child_events() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return *(const std::vector<sc_event *> *)nullptr;
+}
+
+sc_object *
+sc_process_handle::get_parent_object() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return (sc_object *)nullptr;
+}
+
+sc_object *
+sc_process_handle::get_process_object() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return (sc_object *)nullptr;
+}
+
+bool
+sc_process_handle::dynamic() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+bool
+sc_process_handle::terminated() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+const sc_event &
+sc_process_handle::terminated_event() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return *(sc_event *)nullptr;
+}
+
+
+void
+sc_process_handle::suspend(sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+void
+sc_process_handle::resume(sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+void
+sc_process_handle::disable(sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+void
+sc_process_handle::enable(sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+void
+sc_process_handle::kill(sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+void
+sc_process_handle::reset(sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+bool
+sc_process_handle::is_unwinding()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+const sc_event &
+sc_process_handle::reset_event() const
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return *(sc_event *)nullptr;
+}
+
+
+void
+sc_process_handle::sync_reset_on(
+        sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+void
+sc_process_handle::sync_reset_off(
+        sc_descendent_inclusion_info include_descendants)
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+}
+
+void
+sc_process_handle::warn_unimpl(const char *func)
+{
+    warn("%s not implemented.\n", func);
+}
+
+
+sc_process_handle
+sc_get_current_process_handle()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return sc_process_handle();
+}
+
+bool
+sc_is_unwinding()
+{
+    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
+    return false;
+}
+
+} // namespace sc_core
diff --git a/src/systemc/ext/core/sc_process_handle.hh b/src/systemc/ext/core/sc_process_handle.hh
new file mode 100644
index 000000000..ce3fe03cd
--- /dev/null
+++ b/src/systemc/ext/core/sc_process_handle.hh
@@ -0,0 +1,129 @@
+/*
+ * Copyright 2018 Google, Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Gabe Black
+ */
+
+#ifndef __SYSTEMC_EXT_CORE_SC_PROCESS_HANDLE_HH__
+#define __SYSTEMC_EXT_CORE_SC_PROCESS_HANDLE_HH__
+
+#include <exception>
+#include <vector>
+
+namespace sc_core
+{
+
+class sc_event;
+class sc_object;
+
+enum sc_curr_proc_kind
+{
+    SC_NO_PROC_,
+    SC_METHOD_PROC_,
+    SC_THREAD_PROC_,
+    SC_CTHREAD_PROC_
+};
+
+enum sc_descendent_inclusion_info
+{
+    SC_NO_DESCENDANTS,
+    SC_INCLUDE_DESCENDANTS
+};
+
+class sc_unwind_exception : public std::exception
+{
+  public:
+    virtual const char *what() const throw();
+    virtual bool is_reset() const;
+
+  protected:
+    sc_unwind_exception();
+    sc_unwind_exception(const sc_unwind_exception &);
+    virtual ~sc_unwind_exception() throw();
+};
+
+class sc_process_handle
+{
+  public:
+    sc_process_handle();
+    sc_process_handle(const sc_process_handle &);
+    explicit sc_process_handle(sc_object *);
+    ~sc_process_handle();
+
+    bool valid() const;
+
+    sc_process_handle &operator = (const sc_process_handle &);
+    bool operator == (const sc_process_handle &) const;
+    bool operator != (const sc_process_handle &) const;
+    bool operator < (const sc_process_handle &) const;
+    bool swap(sc_process_handle &);
+
+    const char *name() const;
+    sc_curr_proc_kind proc_kind() const;
+    const std::vector<sc_object *> &get_child_objects() const;
+    const std::vector<sc_event *> &get_child_events() const;
+    sc_object *get_parent_object() const;
+    sc_object *get_process_object() const;
+    bool dynamic() const;
+    bool terminated() const;
+    const sc_event &terminated_event() const;
+
+    void suspend(sc_descendent_inclusion_info include_descendants=
+                 SC_NO_DESCENDANTS);
+    void resume(sc_descendent_inclusion_info include_descendants=
+                SC_NO_DESCENDANTS);
+    void disable(sc_descendent_inclusion_info include_descendants=
+                 SC_NO_DESCENDANTS);
+    void enable(sc_descendent_inclusion_info include_descendants=
+                SC_NO_DESCENDANTS);
+    void kill(sc_descendent_inclusion_info include_descendants=
+              SC_NO_DESCENDANTS);
+    void reset(sc_descendent_inclusion_info include_descendants=
+               SC_NO_DESCENDANTS);
+    bool is_unwinding();
+    const sc_event &reset_event() const;
+
+    void sync_reset_on(sc_descendent_inclusion_info include_descendants=
+                       SC_NO_DESCENDANTS);
+    void sync_reset_off(sc_descendent_inclusion_info include_descendants=
+                        SC_NO_DESCENDANTS);
+
+    void warn_unimpl(const char *func);
+    template <typename T>
+    void throw_it(const T &user_defined_exception,
+                  sc_descendent_inclusion_info include_descendants=
+                  SC_NO_DESCENDANTS)
+    {
+        warn_unimpl(__PRETTY_FUNCTION__);
+    }
+};
+
+sc_process_handle sc_get_current_process_handle();
+bool sc_is_unwinding();
+
+} // namespace sc_core
+
+#endif  //__SYSTEMC_EXT_CORE_SC_PROCESS_HANDLE_HH__