tests: Add tests for learning_gem5 configs

Change-Id: Ia9cbb77115c741051c871526517bb7d8124a8051
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/17873
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
Maintainer: Jason Lowe-Power <jason@lowepower.com>

8 files changed, 210 insertions, 0 deletions

diff --git a/tests/gem5/learning_gem5/part1_test.py b/tests/gem5/learning_gem5/part1_test.py
new file mode 100644
index 000000000..968446cc1
--- /dev/null
+++ b/tests/gem5/learning_gem5/part1_test.py
@@ -0,0 +1,48 @@
+# Copyright (c) 2019 The Regents of the University of California.
+# All rights reserved.
+#
+# 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: Jason Lowe-Power
+
+from testlib import *
+
+config_path = joinpath(config.base_dir, 'configs', 'learning_gem5', 'part1')
+
+gem5_verify_config(
+    name='simple_test',
+    verifiers = (),
+    config=joinpath(config_path, 'simple.py'),
+    config_args = [],
+    valid_isas=('X86', 'RISCV', 'ARM'),
+)
+
+gem5_verify_config(
+    name='two_level_test',
+    verifiers = (),
+    config=joinpath(config_path, 'two_level.py'),
+    config_args = [],
+    valid_isas=('X86', 'RISCV', 'ARM'),
+)
+
diff --git a/tests/gem5/learning_gem5/part2_test.py b/tests/gem5/learning_gem5/part2_test.py
new file mode 100644
index 000000000..d3815522e
--- /dev/null
+++ b/tests/gem5/learning_gem5/part2_test.py
@@ -0,0 +1,70 @@
+# Copyright (c) 2019 The Regents of the University of California.
+# All rights reserved.
+#
+# 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: Jason Lowe-Power
+
+from testlib import *
+
+config_path = joinpath(config.base_dir, 'configs', 'learning_gem5', 'part2')
+ref_path = joinpath(getcwd(), 'ref')
+get_verifier = lambda file: verifier.MatchStdout(joinpath(ref_path, file))
+
+gem5_verify_config(
+    name='run_simple_test',
+    verifiers = (get_verifier('simple'),),
+    config=joinpath(config_path, 'run_simple.py'),
+    config_args = [],
+    valid_isas=("NULL",),
+)
+
+gem5_verify_config(
+    name='hello_goodbye_test',
+    verifiers =(get_verifier('hello_goodbye'),),
+    config=joinpath(config_path, 'hello_goodbye.py'),
+    config_args = [],
+    valid_isas=("NULL",),
+)
+
+gem5_verify_config(
+    name='simple_memobj_test',
+    verifiers =(verifier.MatchStdoutNoPerf(joinpath(ref_path, 'hello')),),
+    config=joinpath(config_path, 'simple_memobj.py'),
+    config_args = [],
+    valid_isas=("X86",), # note: by default the above script uses x86
+)
+
+gem5_verify_config(
+    name='simple_cache_test',
+    verifiers =(verifier.MatchStdoutNoPerf(joinpath(ref_path, 'hello')),),
+    config=joinpath(config_path, 'simple_cache.py'),
+    config_args = [],
+    valid_isas=("X86",), # note: by default the above script uses x86
+)
+
+# Note: for simple memobj and simple cache I want to use the traffic generator
+# as well as the scripts above.
+
+
diff --git a/tests/gem5/learning_gem5/part3_test.py b/tests/gem5/learning_gem5/part3_test.py
new file mode 100644
index 000000000..e5563ca05
--- /dev/null
+++ b/tests/gem5/learning_gem5/part3_test.py
@@ -0,0 +1,54 @@
+# Copyright (c) 2019 The Regents of the University of California.
+# All rights reserved.
+#
+# 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: Jason Lowe-Power
+
+from testlib import *
+
+# Note: This isn't going to work because MSI caches won't be built. Need to
+# think more about this. Maybe we should have another parameter to
+# gem5_verify_config...
+
+config_path = joinpath(config.base_dir, 'configs', 'learning_gem5', 'part3')
+ref_path = joinpath(getcwd(), 'ref')
+
+gem5_verify_config(
+    name='simple_ruby_test',
+    verifiers = (verifier.MatchStdoutNoPerf(joinpath(ref_path, 'threads')),),
+    config=joinpath(config_path, 'simple_ruby.py'),
+    config_args = [],
+    protocol = 'MSI',
+    valid_isas=("X86",), # Currently only x86 has the threads test
+)
+
+gem5_verify_config(
+    name='ruby_test_test',
+    verifiers = (verifier.MatchStdout(joinpath(ref_path, 'test')),),
+    config=joinpath(config_path, 'ruby_test.py'),
+    config_args = [],
+    protocol = 'MSI',
+    valid_isas=("X86",), # Currently only x86 has the threads test
+)
diff --git a/tests/gem5/learning_gem5/ref/hello b/tests/gem5/learning_gem5/ref/hello
new file mode 100644
index 000000000..0f0a7d63f
--- /dev/null
+++ b/tests/gem5/learning_gem5/ref/hello
@@ -0,0 +1,7 @@
+gem5 Simulator System.  http://gem5.org
+gem5 is copyrighted software; use the --copyright option for details.
+
+
+Global frequency set at 1000000000000 ticks per second
+Beginning simulation!
+Hello world!
diff --git a/tests/gem5/learning_gem5/ref/hello_goodbye b/tests/gem5/learning_gem5/ref/hello_goodbye
new file mode 100644
index 000000000..8e80377b2
--- /dev/null
+++ b/tests/gem5/learning_gem5/ref/hello_goodbye
@@ -0,0 +1,7 @@
+gem5 Simulator System.  http://gem5.org
+gem5 is copyrighted software; use the --copyright option for details.
+
+
+Global frequency set at 1000000000000 ticks per second
+Beginning simulation!
+Exiting @ tick 10944163 because Goodbye hello!! Goodbye hello!! Goodbye hello!! Goodbye hello!! Goodbye hello!! Goodbye hello!! Goo
diff --git a/tests/gem5/learning_gem5/ref/simple b/tests/gem5/learning_gem5/ref/simple
new file mode 100644
index 000000000..b4c614a0c
--- /dev/null
+++ b/tests/gem5/learning_gem5/ref/simple
@@ -0,0 +1,8 @@
+gem5 Simulator System.  http://gem5.org
+gem5 is copyrighted software; use the --copyright option for details.
+
+
+Global frequency set at 1000000000000 ticks per second
+Hello World! From a SimObject!
+Beginning simulation!
+Exiting @ tick 18446744073709551615 because simulate() limit reached
diff --git a/tests/gem5/learning_gem5/ref/test b/tests/gem5/learning_gem5/ref/test
new file mode 100644
index 000000000..f41673e35
--- /dev/null
+++ b/tests/gem5/learning_gem5/ref/test
@@ -0,0 +1,7 @@
+gem5 Simulator System.  http://gem5.org
+gem5 is copyrighted software; use the --copyright option for details.
+
+
+Global frequency set at 1000000000 ticks per second
+Beginning simulation!
+Exiting @ tick 9831 because Ruby Tester completed
diff --git a/tests/gem5/learning_gem5/ref/threads b/tests/gem5/learning_gem5/ref/threads
new file mode 100644
index 000000000..18a47fddb
--- /dev/null
+++ b/tests/gem5/learning_gem5/ref/threads
@@ -0,0 +1,9 @@
+gem5 Simulator System.  http://gem5.org
+gem5 is copyrighted software; use the --copyright option for details.
+
+
+Global frequency set at 1000000000000 ticks per second
+Beginning simulation!
+Running on 2 cores. with 100 values
+Waiting for other threads to complete
+Validating...Success!