From ccd9210e1a1bdce828a13a4ffdf84548ffe61592 Mon Sep 17 00:00:00 2001
From: Christian Menard <Christian.Menard@tu-dresden.de>
Date: Thu, 9 Feb 2017 19:15:38 -0500
Subject: misc: Clean up and complete the gem5<->SystemC-TLM bridge [4/10]
The current TLM bridge only provides a Slave Port that allows the gem5
world to send request to the SystemC world. This patch series refractors
and cleans up the existing code, and adds a Master Port that allows the
SystemC world to send requests to the gem5 world.
This patch:
* Move common code of the example to a common directory. Move the cli
* parsing from the SimControl module to a separate example object. Add
* comments describing the Gem5SimControl module.
Testing Done: Examples compile and run.
Reviewed at http://reviews.gem5.org/r/3695/
Signed-off-by: Jason Lowe-Power <jason@lowepower.com>
---
util/tlm/examples/common/cli_parser.cc | 126 +++++++++++++++++++++++++++++
util/tlm/examples/common/cli_parser.hh | 70 ++++++++++++++++
util/tlm/examples/common/report_handler.cc | 87 ++++++++++++++++++++
util/tlm/examples/common/report_handler.hh | 42 ++++++++++
4 files changed, 325 insertions(+)
create mode 100644 util/tlm/examples/common/cli_parser.cc
create mode 100644 util/tlm/examples/common/cli_parser.hh
create mode 100644 util/tlm/examples/common/report_handler.cc
create mode 100644 util/tlm/examples/common/report_handler.hh
(limited to 'util/tlm/examples/common')
diff --git a/util/tlm/examples/common/cli_parser.cc b/util/tlm/examples/common/cli_parser.cc
new file mode 100644
index 000000000..b86e99fb8
--- /dev/null
+++ b/util/tlm/examples/common/cli_parser.cc
@@ -0,0 +1,126 @@
+/*
+ * Copyright (c) 2016, Dresden University of Technology (TU Dresden)
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 3. Neither the name of the copyright holder 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 HOLDER
+ * 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: Christian Menard
+ */
+
+#include <iostream>
+#include <sstream>
+
+#include "cli_parser.hh"
+#include "sim/cxx_manager.hh"
+
+void
+CliParser::usage(const std::string& prog_name)
+{
+ std::cerr
+ << "Usage: " << prog_name
+ << (" <config_file.ini> [ <option> ]\n\n"
+ "OPTIONS:\n"
+
+ " -o <offset> -- set memory offset\n"
+ " -d <flag> -- set a gem5 debug flag\n"
+ " (-<flag> clears a flag)\n"
+ " -v -- verbose output\n"
+ " -e <ticks> -- end of simulation after a \n"
+ " given number of ticks\n"
+ "\n");
+ std::exit(EXIT_FAILURE);
+}
+
+void
+CliParser::parse(int argc, char** argv)
+{
+ std::string prog_name(argv[0]);
+
+ unsigned int arg_ptr = 1;
+
+ if (argc == 1) {
+ usage(prog_name);
+ }
+
+ configFile = std::string(argv[arg_ptr]);
+ arg_ptr++;
+
+ // default values
+ verboseFlag = false;
+ simulationEnd = 0;
+ memoryOffset = 0;
+
+ try {
+ while (arg_ptr < argc) {
+ std::string option(argv[arg_ptr]);
+ arg_ptr++;
+ unsigned num_args = argc - arg_ptr;
+
+ if (option == "-d") {
+ if (num_args < 1) {
+ usage(prog_name);
+ }
+ std::string flag(argv[arg_ptr]);
+ arg_ptr++;
+ debugFlags.push_back(flag);
+ } else if (option == "-e") {
+ if (num_args < 1) {
+ usage(prog_name);
+ }
+ std::istringstream(argv[arg_ptr]) >> simulationEnd;
+ arg_ptr++;
+ } else if (option == "-v") {
+ verboseFlag = true;
+ } else if (option == "-o") {
+ if (num_args < 1) {
+ usage(prog_name);
+ }
+ std::istringstream(argv[arg_ptr]) >> memoryOffset;
+ arg_ptr++;
+ /* code */
+ } else {
+ usage(prog_name);
+ }
+ }
+ } catch (CxxConfigManager::Exception &e) {
+ std::cerr << e.name << ": " << e.message << "\n";
+ std::exit(EXIT_FAILURE);
+ }
+
+ parsed = true;
+}
+
+std::string
+CliParser::getDebugFlags()
+{
+ std::stringstream ss;
+ for (auto& flag : debugFlags) {
+ ss << flag << ' ';
+ }
+ return ss.str();
+}
diff --git a/util/tlm/examples/common/cli_parser.hh b/util/tlm/examples/common/cli_parser.hh
new file mode 100644
index 000000000..3f8913115
--- /dev/null
+++ b/util/tlm/examples/common/cli_parser.hh
@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2016, Dresden University of Technology (TU Dresden)
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 3. Neither the name of the copyright holder 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 HOLDER
+ * 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: Christian Menard
+ */
+
+#ifndef __CLI_PARSER_HH__
+#define __CLI_PARSER_HH__
+
+#include <cassert>
+#include <string>
+#include <vector>
+
+class CliParser
+{
+ private:
+ int argc;
+ char** argv;
+
+ bool parsed;
+
+ uint64_t memoryOffset;
+ uint64_t simulationEnd;
+ bool verboseFlag;
+ std::vector<std::string> debugFlags;
+ std::string configFile;
+
+ void usage(const std::string& prog_name);
+ public:
+
+ CliParser() : parsed(false) {}
+
+ void parse(int argc, char** argv);
+
+ uint64_t getMemoryOffset() { assert(parsed); return memoryOffset; }
+ uint64_t getSimulationEnd() { assert(parsed); return simulationEnd; }
+ bool getVerboseFlag() { assert(parsed); return verboseFlag; }
+ std::string getConfigFile() { assert(parsed); return configFile; }
+ std::string getDebugFlags();
+};
+
+#endif
diff --git a/util/tlm/examples/common/report_handler.cc b/util/tlm/examples/common/report_handler.cc
new file mode 100644
index 000000000..56a03ec31
--- /dev/null
+++ b/util/tlm/examples/common/report_handler.cc
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2016, Dresden University of Technology (TU Dresden)
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 3. Neither the name of the copyright holder 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 HOLDER
+ * 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: Christian Menard
+ */
+
+#include <iostream>
+#include <systemc>
+
+#include <sim/core.hh>
+#include <sim/simulate.hh>
+
+#include "report_handler.hh"
+
+using namespace sc_core;
+
+void
+reportHandler(const sc_report &report, const sc_actions &actions)
+{
+ uint64_t systemc_time = report.get_time().value();
+ uint64_t gem5_time = curTick();
+
+ if (actions & SC_DO_NOTHING)
+ return;
+
+ if (actions & SC_DISPLAY || actions & SC_LOG)
+ {
+ std::ostream& stream = actions & SC_DISPLAY ? std::cout : std::cerr;
+
+ stream << report.get_time();
+
+ if (gem5_time < systemc_time) {
+ stream << " (<) ";
+ } else if (gem5_time > systemc_time) {
+ stream << " (!) ";
+ } else {
+ stream << " (=) ";
+ }
+
+ stream << ": " << report.get_msg_type()
+ << ' ' << report.get_msg() << '\n';
+ }
+
+ if (actions & SC_THROW) {
+ std::cerr << "warning: the report handler ignored a SC_THROW action\n";
+ } else if (actions & SC_INTERRUPT) {
+ std::cerr << "warning: the report handler ignored a SC_INTERRUPT"
+ << "action\n";
+ } else if (actions & SC_CACHE_REPORT) {
+ std::cerr << "warning: the report handler ignored a SC_CACHE_REPORT"
+ << "action\n";
+ }
+
+ if (actions & SC_STOP)
+ sc_stop();
+
+ if (actions & SC_ABORT)
+ abort();
+}
diff --git a/util/tlm/examples/common/report_handler.hh b/util/tlm/examples/common/report_handler.hh
new file mode 100644
index 000000000..bd91b77d0
--- /dev/null
+++ b/util/tlm/examples/common/report_handler.hh
@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2016, Dresden University of Technology (TU Dresden)
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 3. Neither the name of the copyright holder 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 HOLDER
+ * 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: Matthias Jung
+ * Christian Menard
+ */
+
+#ifndef __REPORT_HANDLER_HH__
+#define __REPORT_HANDLER_HH__
+
+void reportHandler(const sc_core::sc_report &report,
+ const sc_core::sc_actions &actions);
+
+#endif
--
cgit v1.2.3