systemc: Export the tlm::tlm_global_quantum class to python.

This way the python code can set up the global quantum without having
an sc_main function to do it.

Change-Id: I96df4dea0f1bfe9e3e86d4784bbda8f5b6b74d0b
Reviewed-on: https://gem5-review.googlesource.com/c/16503
Maintainer: Gabe Black <gabeblack@google.com>
Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com>

3 files changed, 60 insertions, 0 deletions

diff --git a/src/systemc/core/SystemC.py b/src/systemc/core/SystemC.py
index 7afbd285b..84424ef1d 100644
--- a/src/systemc/core/SystemC.py
+++ b/src/systemc/core/SystemC.py
@@ -58,6 +58,11 @@ class SystemC_Kernel(SimObject):
         return SystemC_Kernel.ScMainResult(
                 sc_main_result_code(), sc_main_result_str());
 
+    def tlm_global_quantum_instance(self):
+        '''Retrieve the global tlm quantum instance'''
+        from _m5.systemc import tlm_global_quantum
+        return tlm_global_quantum.instance()
+
 # This class represents systemc sc_object instances in python config files. It
 # inherits from SimObject in python, but the c++ version, sc_core::sc_object,
 # doesn't inherit from gem5's c++ SimObject class.
diff --git a/src/systemc/tlm_core/2/quantum/SConscript b/src/systemc/tlm_core/2/quantum/SConscript
index a1580471f..1831b5cba 100644
--- a/src/systemc/tlm_core/2/quantum/SConscript
+++ b/src/systemc/tlm_core/2/quantum/SConscript
@@ -29,3 +29,5 @@ Import('*')
 
 if env['USE_SYSTEMC']:
     Source('global_quantum.cc')
+    if env['USE_PYTHON']:
+        Source('global_quantum_python.cc')
diff --git a/src/systemc/tlm_core/2/quantum/global_quantum_python.cc b/src/systemc/tlm_core/2/quantum/global_quantum_python.cc
new file mode 100644
index 000000000..ebc576d7e
--- /dev/null
+++ b/src/systemc/tlm_core/2/quantum/global_quantum_python.cc
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2019 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 "systemc/core/python.hh"
+#include "systemc/ext/tlm_core/2/quantum/global_quantum.hh"
+
+namespace
+{
+
+struct InstallTlmGlobalQuantum : public ::sc_gem5::PythonInitFunc
+{
+    void
+    run(pybind11::module &systemc) override
+    {
+        pybind11::class_<tlm::tlm_global_quantum>(
+                systemc, "tlm_global_quantum")
+            .def_static("instance", &tlm::tlm_global_quantum::instance,
+                        pybind11::return_value_policy::reference)
+            .def("set", &tlm::tlm_global_quantum::set)
+            .def("get", &tlm::tlm_global_quantum::get)
+            .def("compute_local_quantum",
+                    &tlm::tlm_global_quantum::compute_local_quantum)
+            ;
+    }
+} installTlmGlobalQuantum;
+
+} // anonymous namespace